gh-got editorconfig travis-ci npm

Convenience wrapper for `got` to interact with the GitHub API

gh-got Build Status

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

Related Repositories

gh-got

gh-got

Convenience wrapper for `got` to interact with the GitHub API ...


Top Contributors

sindresorhus SamVerschueren kevva arthurvr dsblv EGul LinusU ntwb tadatuta floatdrop tunnckoCore wangsai

Releases

-   v5.0.0 zip tar
-   v4.0.1 zip tar
-   v4.0.0 zip tar
-   v3.0.0 zip tar
-   v2.4.0 zip tar
-   v2.3.0 zip tar
-   v2.2.0 zip tar
-   v2.1.0 zip tar
-   v2.0.1 zip tar
-   v2.0.0 zip tar
-   v1.0.2 zip tar
-   v1.0.1 zip tar
-   v1.0.0 zip tar
-   1.1.0 zip tar
-   1.0.3 zip tar