Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

readme.md

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 overridden globally with the GITHUB_TOKEN environment variable.

endpoint

Type: string
Default: https://api.github.com/

To support GitHub Enterprise.

Can be overridden globally with the GITHUB_ENDPOINT environment variable.

License

MIT © Sindre Sorhus