richienb/gh-user

Get user info from a GitHub username

gh-user

Get user info from a GitHub username

Install

$ npm install gh-user

Usage

const ghUser = require('gh-user');

(async () => {
	console.log(await ghUser('sindresorhus'));
	//=> {login: 'sindresorhus', id: 170270, …}
})();

API

ghUser(username, [options])

Returns a Promise<Object> with various user info.

username

Type: string

GitHub username.

options

Type: Object

Any gh-got option. To use a GitHub personal access token, for example, pass in:

{
	token: 'YOUR-TOKEN'
}

License

MIT © Sindre Sorhus