npm-name

> Check whether a package or organization name is available on npm

Install

npm install npm-name

Usage

import npmName from 'npm-name';

// Check a package name
console.log(await npmName('chalk'));
//=&gt; false

// Check an organization name
console.log(await npmName('@ava'));
//=&gt; false

console.log(await npmName('@abc123'));
//=&gt; 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
}

API

npmName(name, options?)

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.

npmNameMany(names, options?)

Check whether multiple package/organization names are available (not registered) on npm.

Returns a Promise<map> of name and status.

import {npmNameMany} from 'npm-name';

const result = await npmNameMany(['chalk', '@sindresorhus/is', 'abc123']);

console.log(result.get('chalk'));
//=&gt; false

console.log(result.get('@sindresorhus/is'));
//=&gt; false

console.log(result.get('abc123'));
//=&gt; true

names

Type: string[]

Multiple names to check.

options

Type: object

Same as npmName().

Related

npm-name-cli - CLI for this module

Most popular functions for npm-name

To help you get started, we’ve selected a few npm-name examples, based on popular ways it is used in public projects.

npm-name.many