Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
github-api-promise
Advanced tools
github-api-promise - npm Package Compare versions
Comparing version 1.2.0 to 1.3.0
| { | ||
| "name": "github-api-promise", | ||
| "version": "1.2.0", | ||
| "version": "1.3.0", | ||
| "description": "A node module for interfacing with the Github API using promises", | ||
@@ -5,0 +5,0 @@ "main": "src/app.js", |
@@ -1,2 +0,2 @@ | ||
| # github-api | ||
| # github-api-promise | ||
@@ -9,3 +9,3 @@ A node module for interfacing with the Github API using promises. The full GitHub API documentation can be found at https://developer.github.com/v3/. | ||
| npm install github-api-promise | ||
| ```` | ||
| ``` | ||
@@ -39,3 +39,3 @@ # Usage | ||
| }); | ||
| ```` | ||
| ``` | ||
@@ -49,2 +49,3 @@ For help creating an access token, see the GitHub help article [Creating an Access Token for Command Line Use](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). This package only requires either the _repo_ scope for private repos or the _public_repo_ scope for public repos. | ||
| * [Repositories > Releases](https://developer.github.com/v3/repos/releases/) | ||
| * [Repositories > Repositories](https://developer.github.com/v3/repos/) | ||
| * [Activity > Events](https://developer.github.com/v3/activity/events/) | ||
@@ -54,3 +55,3 @@ | ||
| TODO: JSDoc on github pages | ||
| TODO: JSDoc on github pages. For now, browse the module's source and read the JSDoc comments. | ||
@@ -57,0 +58,0 @@ # Thanks |
@@ -10,5 +10,6 @@ const config = require('../config'); | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-public-events} | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -23,7 +24,8 @@ getEvents: function(params) { | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-repository-events} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -39,7 +41,8 @@ getRepositoryEvents: function(owner, repo, params) { | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -54,7 +57,8 @@ getRepositoryIssueEvents: function(owner, repo, params) { | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -69,6 +73,7 @@ getNetworkRepositoryEvents: function(owner, repo, params) { | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization} | ||
| * @param {string} org - The organization | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {string} org - The organization | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -85,6 +90,7 @@ getOrganizationEvents: function(org, params) { | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received} | ||
| * @param {string} username - The username | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {string} username - The username | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -99,6 +105,7 @@ getUserEventsReceived: function(username, params) { | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received} | ||
| * @param {string} username - The username | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {string} username - The username | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -113,6 +120,7 @@ getUserPublicEventsReceived: function(username, params) { | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user} | ||
| * @param {string} username - The username | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {string} username - The username | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -127,6 +135,7 @@ getUserEvents: function(username, params) { | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user} | ||
| * @param {string} username - The username | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {string} username - The username | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -142,7 +151,8 @@ getUserPublicEvents: function(username, params) { | ||
| * @see {@link https://developer.github.com/v3/activity/events/#list-events-for-an-organization} | ||
| * @param {string} username - The username | ||
| * @param {string} org - The organization | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} Event data | ||
| * @param {string} username - The username | ||
| * @param {string} org - The organization | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} Event data | ||
| */ | ||
@@ -149,0 +159,0 @@ getUserOrganizationEvents: function(username, org, params) { |
@@ -5,2 +5,11 @@ var githubApi = {}; | ||
| githubApi.config = require('./config'); | ||
| githubApi.activity = { | ||
| events: require('./activity/events') | ||
| }; | ||
| githubApi.issues = { | ||
| issues: require('./issues/issues') | ||
| }; | ||
| githubApi.repositories = { | ||
@@ -10,6 +19,3 @@ releases: require('./repositories/releases'), | ||
| }; | ||
| githubApi.repos = githubApi.repositories; // for backwards compatibility | ||
| githubApi.activity = { | ||
| events: require('./activity/events') | ||
| }; | ||
| githubApi.repos = githubApi.repositories; // alias for backwards compatibility | ||
@@ -16,0 +22,0 @@ // Set to window object if there is a window |
@@ -14,10 +14,11 @@ const config = require('../config'); | ||
| * @see {@link https://developer.github.com/v3/repos/#list-your-repositories} | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {string} params.visibility - Can be one of all, public, or private. Default: all | ||
| * @param {string} params.affiliation - default: owner, collaborator, organization_member | ||
| * @param {string} params.type - Can be one of all, owner, public, private, member. Default: all. Will cause a 422 error if used in the same request as visibility or affiliation. | ||
| * @param {string} params.sort - Can be one of created, updated, pushed, full_name. Default: full_name | ||
| * @param {string} params.direction - Can be one of asc or desc. Default: when using full_name: asc; otherwise desc | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} repo data | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {string} params.visibility - Can be one of all, public, or private. Default: all | ||
| * @param {string} params.affiliation - default: owner, collaborator, organization_member | ||
| * @param {string} params.type - Can be one of all, owner, public, private, member. Default: all. Will cause a 422 error if used in the same request as visibility or affiliation. | ||
| * @param {string} params.sort - Can be one of created, updated, pushed, full_name. Default: full_name | ||
| * @param {string} params.direction - Can be one of asc or desc. Default: when using full_name: asc; otherwise desc | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -33,9 +34,10 @@ getMyRepos: function(params) { | ||
| * @see {@link https://developer.github.com/v3/repos/#list-user-repositories} | ||
| * @param {string} username - The specified user | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {string} params.type - Can be one of all, owner, member. Default: owner | ||
| * @param {string} params.sort - Can be one of created, updated, pushed, full_name. Default: full_name | ||
| * @param {string} params.direction - Can be one of asc or desc. Default: when using full_name: asc; otherwise desc | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} repo data | ||
| * @param {string} username - The specified user | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {string} params.type - Can be one of all, owner, member. Default: owner | ||
| * @param {string} params.sort - Can be one of created, updated, pushed, full_name. Default: full_name | ||
| * @param {string} params.direction - Can be one of asc or desc. Default: when using full_name: asc; otherwise desc | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -51,7 +53,8 @@ getUserRepos: function(username, params) { | ||
| * @see {@link https://developer.github.com/v3/repos/#list-organization-repositories} | ||
| * @param {string} org - The specified org | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {string} params.type - Can be one of all, public, private, forks, sources, member. Default: all | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} repo data | ||
| * @param {string} org - The specified org | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {string} params.type - Can be one of all, public, private, forks, sources, member. Default: all | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -68,5 +71,6 @@ getOrgRepos: function(org, params) { | ||
| * @see {@link https://developer.github.com/v3/repos/#list-all-public-repositories} | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {string} params.since - The integer ID of the last Repository that you've seen. | ||
| * @return {JSON} repo data | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {string} params.since - The integer ID of the last Repository that you've seen. | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -82,18 +86,19 @@ getPublicRepositories: function(params) { | ||
| * @see {@link https://developer.github.com/v3/repos/#create} | ||
| * @param {object} body - The request body | ||
| * @param {string} body.name - Required. The name of the repository. | ||
| * @param {string} body.description - A short description of the repository. | ||
| * @param {string} body.homepage - A URL with more information about the repository. | ||
| * @param {boolean} body.private - Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account. Default: false. | ||
| * @param {boolean} body.has_issues - Either true to enable issues for this repository or false to disable them. Default: true. | ||
| * @param {boolean} body.has_projects - Either true to enable projects for this repository or false to disable them. Default: true. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error. | ||
| * @param {boolean} body.has_wiki - Either true to enable the wiki for this repository or false to disable it. Default: true. | ||
| * @param {integer} body.team_id - The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. | ||
| * @param {boolean} body.auto_init - Pass true to create an initial commit with empty README. Default: false. | ||
| * @param {string} body.gitignore_template - Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell". | ||
| * @param {string} body.license_template - Desired LICENSE template to apply. Use the name of the template without the extension. For example, "mit" or "mozilla". | ||
| * @param {boolean} body.allow_squash_merge - Either true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true | ||
| * @param {boolean} body.allow_merge_commit - Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true | ||
| * @param {boolean} body.allow_rebase_merge - Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true | ||
| * @return {JSON} repo data | ||
| * @param {object} body - The request body | ||
| * @param {string} body.name - Required. The name of the repository. | ||
| * @param {string} body.description - A short description of the repository. | ||
| * @param {string} body.homepage - A URL with more information about the repository. | ||
| * @param {boolean} body.private - Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account. Default: false. | ||
| * @param {boolean} body.has_issues - Either true to enable issues for this repository or false to disable them. Default: true. | ||
| * @param {boolean} body.has_projects - Either true to enable projects for this repository or false to disable them. Default: true. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error. | ||
| * @param {boolean} body.has_wiki - Either true to enable the wiki for this repository or false to disable it. Default: true. | ||
| * @param {integer} body.team_id - The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. | ||
| * @param {boolean} body.auto_init - Pass true to create an initial commit with empty README. Default: false. | ||
| * @param {string} body.gitignore_template - Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell". | ||
| * @param {string} body.license_template - Desired LICENSE template to apply. Use the name of the template without the extension. For example, "mit" or "mozilla". | ||
| * @param {boolean} body.allow_squash_merge - Either true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true | ||
| * @param {boolean} body.allow_merge_commit - Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true | ||
| * @param {boolean} body.allow_rebase_merge - Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -108,19 +113,20 @@ createUserRepository: function(body) { | ||
| * @see {@link https://developer.github.com/v3/repos/#create} | ||
| * @param {string} org - The organization in which to create the repository | ||
| * @param {object} body - The request body | ||
| * @param {string} body.name - Required. The name of the repository. | ||
| * @param {string} body.description - A short description of the repository. | ||
| * @param {string} body.homepage - A URL with more information about the repository. | ||
| * @param {boolean} body.private - Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account. Default: false. | ||
| * @param {boolean} body.has_issues - Either true to enable issues for this repository or false to disable them. Default: true. | ||
| * @param {boolean} body.has_projects - Either true to enable projects for this repository or false to disable them. Default: true. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error. | ||
| * @param {boolean} body.has_wiki - Either true to enable the wiki for this repository or false to disable it. Default: true. | ||
| * @param {integer} body.team_id - The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. | ||
| * @param {boolean} body.auto_init - Pass true to create an initial commit with empty README. Default: false. | ||
| * @param {string} body.gitignore_template - Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell". | ||
| * @param {string} body.license_template - Desired LICENSE template to apply. Use the name of the template without the extension. For example, "mit" or "mozilla". | ||
| * @param {boolean} body.allow_squash_merge - Either true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true | ||
| * @param {boolean} body.allow_merge_commit - Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true | ||
| * @param {boolean} body.allow_rebase_merge - Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true | ||
| * @return {JSON} repo data | ||
| * @param {string} org - The organization in which to create the repository | ||
| * @param {object} body - The request body | ||
| * @param {string} body.name - Required. The name of the repository. | ||
| * @param {string} body.description - A short description of the repository. | ||
| * @param {string} body.homepage - A URL with more information about the repository. | ||
| * @param {boolean} body.private - Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account. Default: false. | ||
| * @param {boolean} body.has_issues - Either true to enable issues for this repository or false to disable them. Default: true. | ||
| * @param {boolean} body.has_projects - Either true to enable projects for this repository or false to disable them. Default: true. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error. | ||
| * @param {boolean} body.has_wiki - Either true to enable the wiki for this repository or false to disable it. Default: true. | ||
| * @param {integer} body.team_id - The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. | ||
| * @param {boolean} body.auto_init - Pass true to create an initial commit with empty README. Default: false. | ||
| * @param {string} body.gitignore_template - Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell". | ||
| * @param {string} body.license_template - Desired LICENSE template to apply. Use the name of the template without the extension. For example, "mit" or "mozilla". | ||
| * @param {boolean} body.allow_squash_merge - Either true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true | ||
| * @param {boolean} body.allow_merge_commit - Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true | ||
| * @param {boolean} body.allow_rebase_merge - Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -134,5 +140,6 @@ createOrgRepository: function(org, body) { | ||
| * @see {@link https://developer.github.com/v3/repos/#get} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @return {JSON} repo data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -146,17 +153,18 @@ getRepository: function(owner, repo) { | ||
| * @see {@link https://developer.github.com/v3/repos/#edit} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} body - The request body | ||
| * @param {string} body.name - Required. The name of the repository. | ||
| * @param {string} body.description - A short description of the repository. | ||
| * @param {string} body.homepage - A URL with more information about the repository. | ||
| * @param {boolean} body.private - Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account. Default: false. | ||
| * @param {boolean} body.has_issues - Either true to enable issues for this repository or false to disable them. Default: true. | ||
| * @param {boolean} body.has_projects - Either true to enable projects for this repository or false to disable them. Default: true. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error. | ||
| * @param {boolean} body.has_wiki - Either true to enable the wiki for this repository or false to disable it. Default: true. | ||
| * @param {string} body.default_branch - Updates the default branch for this repository. | ||
| * @param {boolean} body.allow_squash_merge - Either true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true | ||
| * @param {boolean} body.allow_merge_commit - Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true | ||
| * @param {boolean} body.allow_rebase_merge - Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true | ||
| * @return {JSON} repo data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} body - The request body | ||
| * @param {string} body.name - Required. The name of the repository. | ||
| * @param {string} body.description - A short description of the repository. | ||
| * @param {string} body.homepage - A URL with more information about the repository. | ||
| * @param {boolean} body.private - Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account. Default: false. | ||
| * @param {boolean} body.has_issues - Either true to enable issues for this repository or false to disable them. Default: true. | ||
| * @param {boolean} body.has_projects - Either true to enable projects for this repository or false to disable them. Default: true. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error. | ||
| * @param {boolean} body.has_wiki - Either true to enable the wiki for this repository or false to disable it. Default: true. | ||
| * @param {string} body.default_branch - Updates the default branch for this repository. | ||
| * @param {boolean} body.allow_squash_merge - Either true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true | ||
| * @param {boolean} body.allow_merge_commit - Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true | ||
| * @param {boolean} body.allow_rebase_merge - Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -170,7 +178,8 @@ updateRepository: function(owner, repo, body) { | ||
| * @see {@link https://developer.github.com/v3/repos/#list-all-topics-for-a-repository} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} repo data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -185,7 +194,8 @@ getRepositoryTopics: function(owner, repo, params) { | ||
| * @see {@link https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} body - The request body | ||
| * @param {string[]} body.names - Required. An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. | ||
| * @return {JSON} repo data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} body - The request body | ||
| * @param {string[]} body.names - Required. An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([ - ) to clear all topics from the repository. | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -201,8 +211,9 @@ updateRepositoryTopics: function(owner, repo, body) { | ||
| * @see {@link https://developer.github.com/v3/repos/#list-contributors} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.anon - Set to 1 or true to include anonymous contributors in results. | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} repo data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.anon - Set to 1 or true to include anonymous contributors in results. | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -218,5 +229,6 @@ getRepositoryContributors: function(owner, repo, params) { | ||
| * @see {@link https://developer.github.com/v3/repos/#list-languages} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @return {JSON} repo data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -230,7 +242,8 @@ getRepositoryLanguages: function(owner, repo) { | ||
| * @see {@link https://developer.github.com/v3/repos/#list-teams} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} repo data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -245,7 +258,8 @@ getRepositoryTeams: function(owner, repo, params) { | ||
| * @see {@link https://developer.github.com/v3/repos/#list-tags} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * @return {JSON} repo data | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {object} params - An object of parameters for the request | ||
| * @param {int} params.page - The page of results to retrieve | ||
| * | ||
| * @return {JSON} repo data | ||
| */ | ||
@@ -260,4 +274,5 @@ getRepositoryTags: function(owner, repo, params) { | ||
| * @see {@link https://developer.github.com/v3/repos/#} | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * @param {int} owner - The repo's owner id | ||
| * @param {int} repo - The repo id | ||
| * | ||
| * @return {nothing} | ||
@@ -264,0 +279,0 @@ */ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by29.45%
49847
- Number of package files
- increased by11.11%
10
- Lines of code
- increased by24.58%
1044
- Number of lines in readme file
- increased by1.72%
59
No dependency changes