github-username

v8.0.0
Get a GitHub username from an email address
github user username email address gh git

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

npm i github-username

Metadata

  • MIT
  • >=16
  • Sindre Sorhus
  • released 8/5/2023

Downloads

Maintainers