# github-username-options

> Get a GitHub username from an email address. Allows full access to the HTTP request

Latest version **5.0.0** (published 2018-01-24) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install github-username-options
pnpm add github-username-options
yarn add github-username-options
bun add github-username-options
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2018-01-24 |
| First published | 2018-01-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Marco Scabbiolo |
| Maintainers | marcoscabbiolo |
| Keywords | github, user, username, email, address, gh, git |

## Links

- npm: https://www.npmjs.com/package/github-username-options
- Repository: https://github.com/MarcoScabbiolo/github-username-options
- Homepage: https://github.com/MarcoScabbiolo/github-username-options#readme
- Issues: https://github.com/MarcoScabbiolo/github-username-options/issues
- npm.io page: https://npm.io/package/github-username-options

## Dependencies (1)

- [gh-got](https://npm.io/package/gh-got.md) ^6.0.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 5.0.0 (latest) — 2018-01-24

## README

# github-username-options [![Build Status](https://travis-ci.org/MarcoScabbiolo/github-username-options.svg?branch=master)](https://travis-ci.org/MarcoScabbiolo/github-username-options)

> Get a GitHub username from an email address

Based on [github-username](https://github.com/sindresorhus/github-username) but allows you to provide additional options to customize how the HTTP request is performed so you can, for example, use this module behind a proxy. At any moment this module can be merged back into the original one and deprecated, see [this PR](https://github.com/sindresorhus/github-username/pull/8) for more information.


## Install

```
$ npm install github-username-options
```


## Usage

```js
const githubUsername = require('github-username-options');

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


## API

### githubUsername(email, [token], [options])

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](https://github.com/settings/tokens/new).

#### options

Type: `object`

Additional [`http-request` options](https://nodejs.org/api/http.html#http_http_request_options_callback) to use.


## Related

- [github-username-cli](https://github.com/sindresorhus/github-username-cli) - CLI for this module


## License

MIT © Marco Scabbiolo

---
_Source: https://npm.io/package/github-username-options · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._