├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── index.test-d.ts ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 16 14 | steps: 15 | - uses: actions/checkout@v2 16 | - uses: actions/setup-node@v2 17 | with: 18 | node-version: ${{ matrix.node-version }} 19 | - run: npm install 20 | - run: npm test 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | import {RestEndpointMethodTypes, Octokit} from '@octokit/rest'; 2 | 3 | /** 4 | Get user info from a GitHub username. 5 | 6 | @param username - GitHub username. 7 | @param options - Any [Octokit](https://octokit.github.io/rest.js) options. 8 | 9 | @example 10 | ``` 11 | import ghUser from 'gh-user'; 12 | 13 | console.log(await ghUser('sindresorhus')); 14 | //=> {login: 'sindresorhus', id: 170270, …} 15 | ``` 16 | */ 17 | export default function ghUser(username: string, options?: ConstructorParameters[0]): Promise>; // eslint-disable-line @typescript-eslint/ban-types 18 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import {Octokit} from '@octokit/rest'; 2 | 3 | export default async function ghUser(username, options = {}) { 4 | if (typeof username !== 'string' || !username) { 5 | throw new Error('The `username` argument is required'); 6 | } 7 | 8 | if (typeof options !== 'object') { 9 | throw new TypeError('The `options` argument should be an object'); 10 | } 11 | 12 | const octokit = new Octokit({ 13 | userAgent: 'https://github.com/sindresorhus/gh-user', 14 | ...options, 15 | }); 16 | 17 | const {data} = await octokit.users.getByUsername({username}); 18 | 19 | delete data.gravatar_id; 20 | 21 | return data; 22 | } 23 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import {RestEndpointMethodTypes} from '@octokit/rest'; 3 | import ghUser from './index.js'; 4 | 5 | expectType>>( // eslint-disable-line @typescript-eslint/ban-types 6 | ghUser('sindresorhus', {auth: 'deadbeef'}), 7 | ); 8 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | 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: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gh-user", 3 | "version": "6.0.0", 4 | "description": "Get user info from a GitHub username", 5 | "license": "MIT", 6 | "repository": "sindresorhus/gh-user", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": "^12.20.0 || ^14.13.1 || >=16.0.0" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava && tsd" 20 | }, 21 | "files": [ 22 | "index.js", 23 | "index.d.ts" 24 | ], 25 | "keywords": [ 26 | "github", 27 | "gh", 28 | "user", 29 | "username", 30 | "info", 31 | "api" 32 | ], 33 | "dependencies": { 34 | "@octokit/rest": "^18.12.0" 35 | }, 36 | "devDependencies": { 37 | "ava": "^3.15.0", 38 | "tsd": "^0.18.0", 39 | "xo": "^0.45.0" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # gh-user 2 | 3 | > Get user info from a GitHub username 4 | 5 | ## Install 6 | 7 | ```sh 8 | npm install gh-user 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import ghUser from 'gh-user'; 15 | 16 | console.log(await ghUser('sindresorhus')); 17 | //=> {login: 'sindresorhus', id: 170270, …} 18 | ``` 19 | 20 | ## API 21 | 22 | ### ghUser(username, options?) 23 | 24 | Returns a `Promise` with various [user info](https://developer.github.com/v3/users/#response). 25 | 26 | #### username 27 | 28 | Type: `string` 29 | 30 | GitHub username. 31 | 32 | #### options 33 | 34 | Type: `object` 35 | 36 | Any [Octokit](https://octokit.github.io/rest.js) options. 37 | 38 | To use a GitHub [personal access token](https://github.com/settings/tokens/new), for example, pass in: 39 | 40 | ```js 41 | { 42 | token: 'YOUR-TOKEN' 43 | } 44 | ``` 45 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import ghUser from './index.js'; 3 | 4 | test('user exists', async t => { 5 | const user = await ghUser('sindresorhus'); 6 | t.is(user.login, 'sindresorhus'); 7 | }); 8 | 9 | test('user exists (empty options object)', async t => { 10 | const user = await ghUser('sindresorhus', {}); 11 | t.is(user.login, 'sindresorhus'); 12 | }); 13 | 14 | test('user exists (empty token string)', async t => { 15 | const user = await ghUser('sindresorhus', {auth: ''}); 16 | t.is(user.login, 'sindresorhus'); 17 | }); 18 | 19 | test('user doesn\'t exist', async t => { 20 | await t.throwsAsync(ghUser('sindr555esorhus'), {message: 'Not Found'}); 21 | }); 22 | 23 | test('no username given (no arg)', async t => { 24 | await t.throwsAsync(ghUser(), {message: 'The `username` argument is required'}); 25 | }); 26 | 27 | test('no username given (empty string)', async t => { 28 | await t.throwsAsync(ghUser(''), {message: 'The `username` argument is required'}); 29 | }); 30 | 31 | test('username given (bad options type)', async t => { 32 | await t.throwsAsync(ghUser('sindresorhus', 55), {message: 'The `options` argument should be an object'}); 33 | }); 34 | 35 | test('username given (bad token)', async t => { 36 | await t.throwsAsync(ghUser('sindresorhus', {auth: 'NOT-A-TOKEN'}), {message: 'Bad credentials'}); 37 | }); 38 | --------------------------------------------------------------------------------