Skip to content

Commit a91fc87

Browse files
committed
chore: updated callbacks to be Requestable.callback
Closes gh-351
1 parent 2ddd179 commit a91fc87

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

lib/Repository.js

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ class Repository extends Requestable {
313313
* @param {string} parent - the SHA of the parent commit
314314
* @param {string} tree - the SHA of the tree for this commit
315315
* @param {string} message - the commit message
316-
* @param {Function} cb - will receive the commit that is created
316+
* @param {Requestable.callback} cb - will receive the commit that is created
317317
* @return {Promise} - the promise for the http request
318318
*/
319319
commit(parent, tree, message, cb) {
@@ -336,7 +336,7 @@ class Repository extends Requestable {
336336
* @param {string} ref - the ref to update
337337
* @param {string} commitSHA - the SHA to point the reference to
338338
* @param {boolean} force - indicates whether to force or ensure a fast-forward update
339-
* @param {Function} cb - will receive the updated ref back
339+
* @param {Requestable.callback} cb - will receive the updated ref back
340340
* @return {Promise} - the promise for the http request
341341
*/
342342
updateHead(ref, commitSHA, force, cb) {
@@ -349,7 +349,7 @@ class Repository extends Requestable {
349349
/**
350350
* Get information about the repository
351351
* @see https://developer.github.com/v3/repos/#get
352-
* @param {Function} cb - will receive the information about the repository
352+
* @param {Requestable.callback} cb - will receive the information about the repository
353353
* @return {Promise} - the promise for the http request
354354
*/
355355
getDetails(cb) {
@@ -359,7 +359,7 @@ class Repository extends Requestable {
359359
/**
360360
* List the contributors to the repository
361361
* @see https://developer.github.com/v3/repos/#list-contributors
362-
* @param {Function} cb - will receive the list of contributors
362+
* @param {Requestable.callback} cb - will receive the list of contributors
363363
* @return {Promise} - the promise for the http request
364364
*/
365365
getContributors(cb) {
@@ -370,7 +370,7 @@ class Repository extends Requestable {
370370
* List the users who are collaborators on the repository. The currently authenticated user must have
371371
* push access to use this method
372372
* @see https://developer.github.com/v3/repos/collaborators/#list-collaborators
373-
* @param {Function} cb - will receive the list of collaborators
373+
* @param {Requestable.callback} cb - will receive the list of collaborators
374374
* @return {Promise} - the promise for the http request
375375
*/
376376
getCollaborators(cb) {
@@ -381,7 +381,7 @@ class Repository extends Requestable {
381381
* Check if a user is a collaborator on the repository
382382
* @see https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator
383383
* @param {string} username - the user to check
384-
* @param {Function} cb - will receive true if the user is a collaborator and false if they are not
384+
* @param {Requestable.callback} cb - will receive true if the user is a collaborator and false if they are not
385385
* @return {Promise} - the promise for the http request {Boolean} [description]
386386
*/
387387
isCollaborator(username, cb) {
@@ -394,7 +394,7 @@ class Repository extends Requestable {
394394
* @param {string} ref - the ref to check
395395
* @param {string} path - the path containing the content to fetch
396396
* @param {boolean} raw - `true` if the results should be returned raw instead of GitHub's normalized format
397-
* @param {Function} cb - will receive the fetched data
397+
* @param {Requestable.callback} cb - will receive the fetched data
398398
* @return {Promise} - the promise for the http request
399399
*/
400400
getContents(ref, path, raw, cb) {
@@ -409,7 +409,7 @@ class Repository extends Requestable {
409409
* @see https://developer.github.com/v3/repos/contents/#get-the-readme
410410
* @param {string} ref - the ref to check
411411
* @param {boolean} raw - `true` if the results should be returned raw instead of GitHub's normalized format
412-
* @param {Function} cb - will receive the fetched data
412+
* @param {Requestable.callback} cb - will receive the fetched data
413413
* @return {Promise} - the promise for the http request
414414
*/
415415
getReadme(ref, raw, cb) {
@@ -421,7 +421,7 @@ class Repository extends Requestable {
421421
/**
422422
* Fork a repository
423423
* @see https://developer.github.com/v3/repos/forks/#create-a-fork
424-
* @param {Function} cb - will receive the information about the newly created fork
424+
* @param {Requestable.callback} cb - will receive the information about the newly created fork
425425
* @return {Promise} - the promise for the http request
426426
*/
427427
fork(cb) {
@@ -431,7 +431,7 @@ class Repository extends Requestable {
431431
/**
432432
* List a repository's forks
433433
* @see https://developer.github.com/v3/repos/forks/#list-forks
434-
* @param {Function} cb - will receive the list of repositories forked from this one
434+
* @param {Requestable.callback} cb - will receive the list of repositories forked from this one
435435
* @return {Promise} - the promise for the http request
436436
*/
437437
listForks(cb) {
@@ -442,7 +442,7 @@ class Repository extends Requestable {
442442
* Create a new branch from an existing branch.
443443
* @param {string} [oldBranch=master] - the name of the existing branch
444444
* @param {string} newBranch - the name of the new branch
445-
* @param {Function} cb - will receive the commit data for the head of the new branch
445+
* @param {Requestable.callback} cb - will receive the commit data for the head of the new branch
446446
* @return {Promise} - the promise for the http request
447447
*/
448448
createBranch(oldBranch, newBranch, cb) {
@@ -466,7 +466,7 @@ class Repository extends Requestable {
466466
* Create a new pull request
467467
* @see https://developer.github.com/v3/pulls/#create-a-pull-request
468468
* @param {Object} options - the pull request description
469-
* @param {Function} cb - will receive the new pull request
469+
* @param {Requestable.callback} cb - will receive the new pull request
470470
* @return {Promise} - the promise for the http request
471471
*/
472472
createPullRequest(options, cb) {
@@ -476,7 +476,7 @@ class Repository extends Requestable {
476476
/**
477477
* List the hooks for the repository
478478
* @see https://developer.github.com/v3/repos/hooks/#list-hooks
479-
* @param {Function} cb - will receive the list of hooks
479+
* @param {Requestable.callback} cb - will receive the list of hooks
480480
* @return {Promise} - the promise for the http request
481481
*/
482482
listHooks(cb) {
@@ -487,7 +487,7 @@ class Repository extends Requestable {
487487
* Get a hook for the repository
488488
* @see https://developer.github.com/v3/repos/hooks/#get-single-hook
489489
* @param {number} id - the id of the webook
490-
* @param {Function} cb - will receive the details of the webook
490+
* @param {Requestable.callback} cb - will receive the details of the webook
491491
* @return {Promise} - the promise for the http request
492492
*/
493493
getHook(id, cb) {
@@ -498,7 +498,7 @@ class Repository extends Requestable {
498498
* Add a new hook to the repository
499499
* @see https://developer.github.com/v3/repos/hooks/#create-a-hook
500500
* @param {Object} options - the configuration describing the new hook
501-
* @param {Function} cb - will receive the new webhook
501+
* @param {Requestable.callback} cb - will receive the new webhook
502502
* @return {Promise} - the promise for the http request
503503
*/
504504
createHook(options, cb) {
@@ -510,7 +510,7 @@ class Repository extends Requestable {
510510
* @see https://developer.github.com/v3/repos/hooks/#edit-a-hook
511511
* @param {number} id - the id of the webhook
512512
* @param {Object} options - the new description of the webhook
513-
* @param {Function} cb - will receive the updated webhook
513+
* @param {Requestable.callback} cb - will receive the updated webhook
514514
* @return {Promise} - the promise for the http request
515515
*/
516516
updateHook(id, options, cb) {
@@ -521,7 +521,7 @@ class Repository extends Requestable {
521521
* Delete a webhook
522522
* @see https://developer.github.com/v3/repos/hooks/#delete-a-hook
523523
* @param {number} id - the id of the webhook to be deleted
524-
* @param {Function} cb - will receive true if the call is successful
524+
* @param {Requestable.callback} cb - will receive true if the call is successful
525525
* @return {Promise} - the promise for the http request
526526
*/
527527
deleteHook(id, cb) {
@@ -533,7 +533,7 @@ class Repository extends Requestable {
533533
* @see https://developer.github.com/v3/repos/contents/#delete-a-file
534534
* @param {string} branch - the branch to delete from, or the default branch if not specified
535535
* @param {string} path - the path of the file to remove
536-
* @param {Function} cb - will receive the commit in which the delete occurred
536+
* @param {Requestable.callback} cb - will receive the commit in which the delete occurred
537537
* @return {Promise} - the promise for the http request
538538
*/
539539
deleteFile(branch, path, cb) {
@@ -553,7 +553,7 @@ class Repository extends Requestable {
553553
* @param {string} branch - the branch to carry out the reference change, or the default branch if not specified
554554
* @param {string} oldPath - original path
555555
* @param {string} newPath - new reference path
556-
* @param {Function} cb - will receive the commit in which the move occurred
556+
* @param {Requestable.callback} cb - will receive the commit in which the move occurred
557557
* @return {Promise} - the promise for the http request
558558
*/
559559
move(branch, oldPath, newPath, cb) {
@@ -588,7 +588,7 @@ class Repository extends Requestable {
588588
* @param {Object} [options.author] - the author of the commit
589589
* @param {Object} [options.commiter] - the committer
590590
* @param {boolean} [options.encode] - true if the content should be base64 encoded
591-
* @param {Function} cb - will receive the new commit
591+
* @param {Requestable.callback} cb - will receive the new commit
592592
* @return {Promise} - the promise for the http request
593593
*/
594594
writeFile(branch, path, content, message, options, cb) {

0 commit comments

Comments
 (0)