Require Node.js 10

.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: CI
+on:
+ - push
+ - pull_request
+jobs:
+ test:
+ name: Node.js ${{ matrix.node-version }}
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ node-version:
+ - 14
+ - 12
+ - 10
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-node@v1
+ with:
+ node-version: ${{ matrix.node-version }}
+ - run: npm install
+ - run: npm test

index.d.ts

@@ -1,9 +1,9 @@
 /**
-Get a GitHub username from an email address.
+Get the GitHub username from an email address if the email can be found in any commits on GitHub.
 
 @param email - Email address for the user of whom you want the username.
 @param token - GitHub [personal access token](https:/settings/tokens/new).
-@returns The username for the `email`.
+@returns The username for the `email` or `undefined` if it cannot be found.
 
 @example
 ```
@@ -15,6 +15,6 @@ import githubUsername = require('github-username');
 })();
 ```
 */
-declare function githubUsername(email: string, token?: string): Promise<string>;
+declare function githubUsername(email: string, token?: string): Promise<string | undefined>;
 
 export = githubUsername;

index.test-d.ts

@@ -1,6 +1,6 @@
 import {expectType} from 'tsd';
 import githubUsername = require('.');
 
-expectType<Promise<string>>(
+expectType<Promise<string | undefined>>(
  githubUsername('[email protected]', 'deadbeef')
 );

license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <[email protected]> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package.json

@@ -4,13 +4,14 @@
  "description": "Get a GitHub username from an email address",
  "license": "MIT",
  "repository": "sindresorhus/github-username",
+ "funding": "https:/sponsors/sindresorhus",
  "author": {
  "name": "Sindre Sorhus",
  "email": "[email protected]",
- "url": "sindresorhus.com"
+ "url": "https://sindresorhus.com"
  },
  "engines": {
- "node": ">=8"
+ "node": ">=10"
  },
  "scripts": {
  "test": "xo && ava && tsd"
@@ -32,8 +33,8 @@
  "@octokit/rest": "^18.0.6"
  },
  "devDependencies": {
- "ava": "^1.4.1",
- "tsd": "^0.7.2",
- "xo": "^0.24.0"
+ "ava": "^2.4.0",
+ "tsd": "^0.14.0",
+ "xo": "^0.36.1"
  }
 }

readme.md

@@ -1,15 +1,13 @@
-# github-username [![Build Status](https://travis-ci.org/sindresorhus/github-username.svg?branch=master)](https://travis-ci.org/sindresorhus/github-username)
+# github-username
 
 > Get a GitHub username from an email address
 
-
 ## Install
 
 ```
 $ npm install github-username
 ```
 
-
 ## Usage
 
 ```js
@@ -21,12 +19,13 @@ const githubUsername = require('github-username');
 })();
 ```
 
-
 ## API
 
-### githubUsername(email, [token])
+### 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.
+Returns a `Promise<string?>` with the username.
 
 #### email
 
@@ -40,12 +39,6 @@ Type: `string`
 
 GitHub [personal access token](https:/settings/tokens/new).
 
-
 ## Related
 
 - [github-username-cli](https:/sindresorhus/github-username-cli) - CLI for this module
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)