JSPM

is-github-user-or-org

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

Determines whether a GitHub profile is a User or an Organization

Package Exports

  • is-github-user-or-org

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 (is-github-user-or-org) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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