Skip to content

sindresorhus/github-username

Repository files navigation

github-username

Get a GitHub username from an email address

Install

npm install github-username

Usage

import githubUsername from 'github-username';

console.log(await githubUsername('[email protected]'));
//=> 'sindresorhus'

API

githubUsername(email, options?)

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

The email address for the user of whom you want the username.

options

Type: object

token

Type: string

GitHub personal access token.

Related

About

Get a GitHub username from an email address

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 9