You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
3 years ago | |
---|---|---|
.. | ||
node_modules/is-plain-obj | 3 years ago | |
index.js | 3 years ago | |
license | 3 years ago | |
package.json | 3 years ago | |
readme.md | 3 years ago |
readme.md
gh-got 
Convenience wrapper for
got
to interact with the GitHub API
Install
$ npm install --save gh-got
Usage
Instead of:
const got = require('got');
const token = 'foo';
got('https://api.github.com/users/sindresorhus', {
json: true,
headers: {
'accept': 'application/vnd.github.v3+json',
'authorization': `token ${token}`
}
}).then(res => {
console.log(res.body.login);
//=> 'sindresorhus'
});
You can do:
const ghGot = require('gh-got');
ghGot('users/sindresorhus', {token: 'foo'}).then(res => {
console.log(res.body.login);
//=> 'sindresorhus'
});
Or:
const ghGot = require('gh-got');
ghGot('https://api.github.com/users/sindresorhus', {token: 'foo'}).then(res => {
console.log(res.body.login);
//=> 'sindresorhus'
});
API
Same as got
(including the stream API and aliases), but with some additional options:
token
Type: string
GitHub access token.
Can be set globally with the GITHUB_TOKEN
environment variable.
endpoint
Type: string
Default: https://api.github.com/
To support GitHub Enterprise.
Can be set globally with the GITHUB_ENDPOINT
environment variable.
body
Type: Object
Can be specified as a plain object and will be serialized as JSON with the appropriate headers set.
License
MIT © Sindre Sorhus