0.1.0 • Published 4 months ago
github-username-to-emails v0.1.0
Usage
npm i github-username-to-emails
import { getGitHubUsernameEmails } from "github-username-to-emails";
await getGitHubUsernameEmails({ username: "joshuakgoldberg" });
/*
{
account: 'github@joshuakgoldberg.com',
events: { 'git@joshuakgoldberg.com': [ 'Josh Goldberg ✨', 'Josh Goldberg' ] }
}
*/
Calling getGitHubUsernameEmails
will try to find the user's email from two public data points:
/users/${username}
: public account information/users/{username}/events
:
Note that account
might be undefined
and events
might be {}
.
Only publicly visible emails can be retrieved.
Options
auth
must be provided as an option or via process.env.GH_TOKEN
.
Option | Type | Description | Default |
---|---|---|---|
auth | string | Auth token for Octokit REST calls. | process.env.GH_TOKEN |
historyLimit | number | How many public events to look at. | 500 |
username | string | GitHub user to check emails of. |
await getGitHubUsernameEmails({
auth: "gho_abc123",
historyLimit: 9001,
username: "joshuakgoldberg",
});
Email Privacy
This package doesn't expose any data users aren't already providing to GitHub. You can manually check the same data it looks at on:
- A user's public GitHub profile
https://api.github.com/users/<username>/events
This package only serves as a convenience to same time searching through that data.
To hide your email from public view, see GitHub's Setting your commit email address docs.
Contributors
💙 This package was templated with
create-typescript-app
.
0.1.0
4 months ago