1.2.0 • Published 5 years ago

is-github-user-or-org v1.2.0

Weekly downloads
33
License
MIT
Repository
github
Last release
5 years ago

is-github-user-or-org Build Status

Determines whether a GitHub profile is a User or an Organization

Install

$ npm install --save is-github-user-or-org

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 isGithubUserOrOrg = require('is-github-user-or-org')

isGithubUserOrOrg('RichardLitt')
//=> 'User'

API

isGithubUserOrOrg(input)

input

Type: string

The user or organization you want to check the type of

token

Type: token

The GitHub personal access token.

endpoint

Type: string

The GitHub enterprise endpoint.

CLI

$ npm install --global is-github-user-or-org
$ is-github-user-or-org --help

  Usage
    $ is-github-user-or-org <input>

  Options
    -t, --token A token
    -e, --endpoint A GitHub endpoint (for Enterprise)

  Examples
    $ get-github-user RichardLitt
    User
    $ get-github-user OpenSourceDesign
    Organization

License

MIT © 2017 Richard Littauer