Skip to content
Navigation Menu
{{ message }}
forked from octokit/octokit.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpullRequests.js.html
More file actions
422 lines (400 loc) · 22.2 KB
/
Copy pathpullRequests.js.html
File metadata and controls
422 lines (400 loc) · 22.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: api/pullRequests.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: api/pullRequests.js</h1>
<section>
<article>
<pre class="prettyprint source"><code>/*global define*/
define(function(){
'use strict';
/**
* @exports pullRequests
* @memberof Client
*/
var pullRequests = {
pullRequests: {}
};
var handler = function(afterRequest){
return function(msg, block, callback) {
var self = this;
this.client.httpSend(msg, block, function(err, res) {
if (err) {
return self.sendError(err, null, msg, callback);
}
var ret;
if (typeof res.headers !== 'undefined' && typeof res.headers['content-type'] !== 'undefined' && res.headers['content-type'].indexOf('text/html') > -1) {
ret = {
data: res.data
};
} else {
try {
ret = res.data && JSON.parse(res.data);
} catch (ex) {
if (callback) {
callback(new Error(ex), res);
}
return;
}
}
ret = afterRequest(ret, res);
if (callback){
callback(null, ret);
}
});
};
};
var getAllAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {String} [msg.state] Validation rule: ` ^(open|closed)$ `.
* @param {Number} [msg.page] Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
* @param {Number} [msg.per_page] A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.getAll = handler(getAllAfterRequest);
var getAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.get = handler(getAfterRequest);
var createAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {String} msg.title
* @param {String} [msg.body]
* @param {String} msg.base Required string - The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
* @param {String} msg.head Required string - The branch (or git ref) where your changes are implemented.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.create = handler(createAfterRequest);
var createFromIssueAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.issue Validation rule: ` ^[0-9]+$ `.
* @param {String} msg.base Required string - The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
* @param {String} msg.head Required string - The branch (or git ref) where your changes are implemented.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.createFromIssue = handler(createFromIssueAfterRequest);
var updateAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {String} [msg.state] Validation rule: ` ^(open|closed)$ `.
* @param {String} msg.title
* @param {String} [msg.body]
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.update = handler(updateAfterRequest);
var getCommitsAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {Number} [msg.page] Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
* @param {Number} [msg.per_page] A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.getCommits = handler(getCommitsAfterRequest);
var getFilesAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {Number} [msg.page] Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
* @param {Number} [msg.per_page] A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.getFiles = handler(getFilesAfterRequest);
var getMergedAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {Number} [msg.page] Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
* @param {Number} [msg.per_page] A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.getMerged = handler(getMergedAfterRequest);
var mergeAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {String} [msg.commit_message] Optional string - The message that will be used for the merge commit
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.merge = handler(mergeAfterRequest);
var getCommentsAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {Number} [msg.page] Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
* @param {Number} [msg.per_page] A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.getComments = handler(getCommentsAfterRequest);
var getCommentAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.getComment = handler(getCommentAfterRequest);
var createCommentAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {String} msg.body
* @param {String} msg.commit_id Required string - Sha of the commit to comment on.
* @param {String} msg.path Required string - Relative path of the file to comment on.
* @param {Number} msg.position Required number - Column index in the diff to comment on.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.createComment = handler(createCommentAfterRequest);
var createCommentReplyAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {String} msg.body
* @param {Number} msg.in_reply_to
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.createCommentReply = handler(createCommentReplyAfterRequest);
var updateCommentAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {String} msg.body
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.updateComment = handler(updateCommentAfterRequest);
var deleteCommentAfterRequest = function(ret, res){
ret = ret || {};
ret.meta = ret.meta || {};
['x-ratelimit-limit', 'x-ratelimit-remaining', 'x-oauth-scopes', 'link', 'location', 'last-modified', 'etag', 'status'].forEach(function(header) {
if (res.headers[header]) {
ret.meta[header] = res.headers[header];
}
});
return ret;
};
/**
* @function
* @param {Object} msg Object that contains the parameters and their values to be sent to the server.
* @param {Object} [msg.headers] Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: If-Modified-Since, If-None-Match, Cookie, User-Agent
* @param {String} msg.user
* @param {String} msg.repo
* @param {Number} msg.number Validation rule: ` ^[0-9]+$ `.
* @param {Function} callback function to call when the request is finished with an error as first argument and result data as second argument.
**/
pullRequests.pullRequests.deleteComment = handler(deleteCommentAfterRequest);
return pullRequests;
});
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="authorization.html">authorization</a></li><li><a href="events.html">events</a></li><li><a href="gists.html">gists</a></li><li><a href="gitdata.html">gitdata</a></li><li><a href="issues.html">issues</a></li><li><a href="markdown.html">markdown</a></li><li><a href="orgs.html">orgs</a></li><li><a href="pullRequests.html">pullRequests</a></li><li><a href="repos.html">repos</a></li><li><a href="search.html">search</a></li><li><a href="statuses.html">statuses</a></li><li><a href="user.html">user</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="HttpError.html">HttpError</a></li><li><a href="Util.html">Util</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Mar 16 2014 22:12:03 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
You can’t perform that action at this time.