Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/richardlitt/is-github-user-or-org

Determines whether a GitHub profile is a User or an Organization
https://github.com/richardlitt/is-github-user-or-org

api cli github github-api javascript organization user

Last synced: 30 days ago
JSON representation

Determines whether a GitHub profile is a User or an Organization

Awesome Lists containing this project

README

        

# is-github-user-or-org [![Build Status](https://travis-ci.org/RichardLitt/is-github-user-or-org.svg?branch=master)](https://travis-ci.org/RichardLitt/is-github-user-or-org)

> 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

```js
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

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](license) © 2017 [Richard Littauer](http://burntfen.com)