Package Exports

github-reserved-names
github-reserved-names/reserved-names.json

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

Readme

GitHub-reserved-names

Get a list, or check if a user or organization name is reserved by GitHub

This is by no means a complete list of reserved GitHub user/organization names.

The list in this repository was gathered from several sources:

Octotree (ref).
GitHub Hovercard (ref).
GitHub Custom Hotkeys Userscript (ref).
shorten-repo-url (ref).
And manually entering names into https://github.com/account/organizations/new and seeing it labeled as "Reserved".

See the history page for more details and how you can help expand this list.

Install

$ npm install --save github-reserved-names

Usage

const isReserved = require('github-reserved-names');

isReserved.check("settings");
//=> true

isReserved.check("google");
//=> false

isReserved.all;
// [ 400, 401, 402, ..., "trending", "watching" ]

API

.all

Type: array

Current list of gathered GitHub reserved names.

.check()

Type: function

Returns a boolean of true if the name is in the reserved list, false is not.

CLI

$ npm install --global github-reserved-names

$ github-reserved --help

  Examples
    $ github-reserved issues
    true

    $ github-reserved --all
    400
    401
    ...

  Options
    --all   Show all reserved names

License

MIT