Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Convenience wrapper for
got
to interact with the GitHub API
$ npm install gh-got
Instead of:
const got = require('got');
const token = 'foo';
(async () => {
const {body} = await got('https://api.github.com/users/sindresorhus', {
json: true,
headers: {
'accept': 'application/vnd.github.v3+json',
'authorization': `token ${token}`
}
});
console.log(body.login);
//=> 'sindresorhus'
})();
You can do:
const ghGot = require('gh-got');
(async () => {
const {body} = await ghGot('users/sindresorhus', {token: 'foo'});
console.log(body.login);
//=> 'sindresorhus'
})();
Or:
const ghGot = require('gh-got');
(async () => {
const {body} = await ghGot('https://api.github.com/users/sindresorhus', {token: 'foo'});
console.log(body.login);
//=> 'sindresorhus'
})();
Same as got
(including the stream API and aliases), but with some additional options below.
Errors are improved by using the custom GitHub error messages. Doesn't apply to the stream API.
Type: string
GitHub access token.
Can be set globally with the GITHUB_TOKEN
environment variable.
Type: string
Default: https://api.github.com/
To support GitHub Enterprise.
Can be set globally with the GITHUB_ENDPOINT
environment variable.
Type: Object
Can be specified as a plain object and will be serialized as JSON with the appropriate headers set.
Authorization for GitHub uses the following logic:
options.headers.authorization
is passed to gh-got
, then this will be used as first preference.options.token
is provided, then the authorization
header will be set to token <options.token>
.options.headers.authorization
and options.token
are not provided, then the authorization
header will be set to token <process.env.GITHUB_TOKEN>
In most cases, this means you can simply set GITHUB_TOKEN
, but it also allows it to be overridden by setting options.token
or options.headers.authorization
explicitly. For example, if authenticating as a GitHub App, you could do the following:
const ghGot = require(`gh-got`);
(async () => {
const options = {
headers: {
authorization: `Bearer ${jwt}`
}
};
const {body} = await ghGot('app', options);
console.log(body.name);
//=> 'MyApp'
})();
MIT © Sindre Sorhus
FAQs
Convenience wrapper for Got to interact with the GitHub API
We found that gh-got demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.