gh-user

Get user info from a GitHub username

Usage no npm install needed!

<script type="module">
  import ghUser from 'https://cdn.skypack.dev/gh-user';
</script>

README

gh-user

Get user info from a GitHub username

Install

$ npm install gh-user

Usage

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

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 Octokit option. To use a GitHub personal access token, for example, pass in:

{
    token: 'YOUR-TOKEN'
}