Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Scan npm for available package names

License

Notifications You must be signed in to change notification settings

feross/available

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

63 Commits

Repository files navigation

Scan npm for available package names

install

npm install available -g

usage

cli

Get available names from the npm registry:

$ available
your
was
our
...

Full options list:

Usage:
 available [optional-name] <options>
 Scan npm for available package names.
Examples:
 Print lots of possible names:
 available
 available --offline
 Check for a certain name:
 available my-cool-name
 available my-cool-name --related
 available my-cool-name --offline
Flags:
 -r, --related Search for related module names (Uses thesaurus)
 -o, --offline Force offline mode (Does not verify names are actually available)
 -v, --version Show current version
 -h, --help Show usage information

api

available.getNames(opts, next)

Get available package names from npm.

If opts.online is true, verify that the names are actually available. Otherwise, a local package name database is used, which may be slightly out-of-date.

next(err, name) is called each time an available package is found. This allows for "streaming" the possible names from the registry. If err is an Error, then there was a problem and next will not be called again. name is the available package name.

available.checkName(name, opts, next)

Check if a specific name is available on npm.

If opts.online is true, verify that the names are actually available. Otherwise, a local package name database is used, which may be slightly out-of-date.

If opts.related is true, then this will search for related module names using a thesaurus.

next(err, name) is called each time an available package is found. This allows for "streaming" the possible names from the registry. If err is an Error, then there was a problem and next will not be called again. name is the available package name.

license

MIT. Copyright (c) Feross Aboukhadijeh.

About

Scan npm for available package names

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 4

AltStyle によって変換されたページ (->オリジナル) /