github-username

Get a GitHub username from an email address

Usage no npm install needed!

<script type="module">
  import githubUsername from 'https://cdn.skypack.dev/github-username';
</script>

README

github-username

Get a GitHub username from an email address

Install

$ npm install github-username

Usage

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

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

API

githubUsername(email, token?)

Get the GitHub username from an email address if the email can be found in any commits on GitHub.

Returns a Promise<string?> with the username.

email

Type: string

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

token

Type: string

GitHub personal access token.

Related