Check whether a package or organization name is available on npm
npm install npm-name> Check whether a package or organization name is available on npm
``sh`
npm install npm-name
`js
import npmName from 'npm-name';
// Check a package name
console.log(await npmName('chalk'));
//=> false
// Check an organization name
console.log(await npmName('@ava'));
//=> false
console.log(await npmName('@abc123'));
//=> true
try {
await npmName('_ABC');
} catch (error) {
console.log(error.message);
// Invalid package name: _ABC
// - name cannot start with an underscore
// - name can no longer contain capital letters
}
`
Check whether a package/organization name is available (not registered) on npm.
An organization name should start with @ and should not be a scoped package.
Returns a Promise of whether the given name is available.
#### name
Type: string
The name to check.
#### options
Type: object
##### registryUrl
Default: User's configured npm registry URL.
The registry URL to check name availability against.
Note: You're unlikely to need this option. Most use-cases are best solved by using the default. You should only use this option if you need to check a package name against a specific registry.
Check whether multiple package/organization names are available (not registered) on npm.
Returns a Promise
`js
import {npmNameMany} from 'npm-name';
const result = await npmNameMany(['chalk', '@sindresorhus/is', 'abc123']);
console.log(result.get('chalk'));
//=> false
console.log(result.get('@sindresorhus/is'));
//=> false
console.log(result.get('abc123'));
//=> true
`
#### names
Type: string[]
Multiple names to check.
#### options
Type: object
Same as npmName().
This package checks the npm registry to see if a name is already taken. It also detects names that differ from existing packages only by punctuation (-, ., _), which npm blocks at publish time. For example, ch-alk will be reported as unavailable because chalk` exists.
However, npm also performs additional undocumented similarity checks server-side that may still reject a name at publish time even if this package reports it as available. There is no public API to replicate these checks.
- npm-name-cli - CLI for this module