Awesome
topics
Get and update GitHub repository topics.
Follow this project's author, Jon Schlinkert, for updates on this project and others.
Install
Install with npm:
$ npm install --save topics
Usage
This library uses github-base. Visit that library's github repository for documentation about all available options and authentication options.
var topics = require('topics');
Example response
Status: 200 OK
{
"names": [
"octocat",
"atom",
"electron",
"API"
]
}
API
topics
List all topics for a repository. The main export is a function that calls the .get method.
Params
owner
{String}: Eitherowner/repo
combination, orowner
ifrepo
is the second argument.repo
{String|Object}: Repository name or options.options
{Object}returns
{Promise}
Example
var options = {
username: 'your_username',
password: 'your_password'
};
topics('micromatch/micromatch', options)
.then(function(topics) {
console.log('topics', topics);
})
.catch(console.error)
.request
Create a topics request with the given method
, owner
, repo
and options
.
Params
method
{String}owner
{String}: Eitherowner/repo
combination, orowner
ifrepo
is the second argument.repo
{String|Object}: Repository name or options.options
{Object}returns
{Promise}
Example
var options = {
username: 'your_username',
password: 'your_password'
};
topics.request('get', 'micromatch', 'micromatch', options)
.then(function(topics) {
console.log('topics', topics);
})
.catch(console.error)
.get
List all topics for a repository.
Params
owner
{String}: Eitherowner/repo
combination, orowner
ifrepo
is the second argument.repo
{String|Object}: Repository name or options.options
{Object}returns
{Promise}
Example
var options = {
username: 'your_username',
password: 'your_password'
};
topics.get('micromatch/micromatch', options)
.then(function(topics) {
console.log('topics', topics);
})
.catch(console.error)
.put
Replace all topics for a repository.
Params
owner
{String}: Eitherowner/repo
combination, orowner
ifrepo
is the second argument.repo
{String|Object}: Repository name or options.options
{Object}returns
{Promise}
Example
var options = {
username: 'your_username',
password: 'your_password',
// new topics to use (overwrites all existing topics)
names: [
'foo',
'bar',
'baz'
]
};
topics.put('micromatch/micromatch', options)
.then(function(topics) {
console.log('topics', topics);
})
.catch(console.error)
.patch
Gets all topics for a repository and then replaces the existing topics with one or more additional topics defined on options.names
. Send an empty array (`[]
Params
owner
{String}: Eitherowner/repo
combination, orowner
ifrepo
is the second argument.repo
{String|Object}: Repository name or options.options
{Object}returns
{Promise}
Example
var options = {
username: 'your_username',
password: 'your_password',
// new topics to use (overwrites all existing topics)
names: [
'foo',
'bar',
'baz'
]
};
topics.patch('micromatch/micromatch', options)
.then(function(topics) {
console.log('topics', topics);
})
.catch(console.error)
.normalize
Utility for normalizing options. This is already used in necessary places in the other request methods, but it's exposed for unit tests and debugging.
Params
owner
{String}repo
{String}options
{String}returns
{Object}: Returns the options object to use with the request methods.
About
Related projects
You might also be interested in these projects:
- commits: List the commits on a GitHub repository. | homepage
- gists: Methods for working with the GitHub Gist API. Node.js/JavaScript | homepage
- github-base: JavaScript wrapper that greatly simplifies working with GitHub's API. | homepage
- github-contributors: Generate a markdown or JSON list of contributors for a project using the GitHub API. | homepage
- github-metadata: Gather GitHub metadata about a repository. | homepage
- github-traffic: Get the Github traffic for the specified repository | homepage
- github-trees: Get a tree from a GitHub repository. | homepage
- repos: Pull down a list of GitHub repositories for the specified user or org, and save… more | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Contributors
Commits | Contributor |
---|---|
10 | jonschlinkert |
2 | doowb |
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Author
Jon Schlinkert
License
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on August 21, 2017.