/github-username

Get a GitHub username from an email address

Primary LanguageJavaScriptMIT LicenseMIT

github-username Build Status

Get a GitHub username from an email address

Only works for users that have their email publicly listed on their profile.

Install

$ npm install --save github-username

Usage

const githubUsername = require('github-username');

githubUsername('sindresorhus@gmail.com').then(username => {
	console.log(username);
	//=> 'sindresorhus'
});

API

githubUsername(email, [token])

Returns a Promise for the username.

email

Type: string

Email address for the user of whom you want the username.

token

Type: string

GitHub personal access token.

Related

License

MIT © Sindre Sorhus