JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 91
  • Score
    100M100P100Q80308F
  • License MIT

Get GitHub user information from just a username

Package Exports

  • get-github-user
  • get-github-user/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (get-github-user) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

get-github-user Build Status

Get GitHub user information from just a username

Install

$ npm install --save get-github-user

You also need to get a GitHub application token: https://github.com/settings/tokens. Provide it in the CLI or set it as $GITHUB_TOKEN somewhere in your bash_profile.

Usage

const getGithubUser = require('get-github-user');

getGithubUser('RichardLitt');
//=> [{login: 'RichardLitt', ...}]

API

getGithubUser(input)

input

Type: string or array

The user or array of users you want user objects for.

token

Type: token

Send in your GitHub token.

endpoint

Type: string

Send in your GitHub Enterprise endpoint or rootURL.

CLI

$ npm install --global get-github-user
$ get-github-user --help

  Usage
    $ get-github-user [input]

  Options
    -t, --token A token
    -e, --endpoint Change the GitHub endpoint

  Examples
    $ get-github-user RichardLitt
    [{ login: 'RichardLitt',  ... }]
    $ get-github-user RichardLitt jbenet
    [{...}, {...}]

Contribute

Please do! Open an issue or a pull request if you see anything.

License

MIT © Richard Littauer