7.0.0 • Published 5 months ago

npm-name v7.0.0

Weekly downloads
43,686
License
MIT
Repository
github
Last release
5 months ago

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'));
//=> 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
}

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<boolean> of whether the given name is available.

name

Type: string

Name to check.

options

Type: object

registryUrl

Default: User's configured npm registry URL.

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'));
//=> 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().

Related

@cyber-start/create-cyber-library@cyber-start/create-cyber-tools@cyber-tools/cyber-order@cyber-tools/lib-clireactifire6ttypescriptifire@yushicheng/create-private-lib@cyber-tools/work-cli@cyber-work/create-cyber-work@cyber-work/lib-cli@cyber-work/work-cliwork-scriptsgenerator-easy-gruntplugingenerator-easy-nodegenerator-howmanydiscord.js-byconmvnpm@types/npm-name@minar-kotonoha/inquirer-npm-namenpwordageversion-existsutilifire@jacekpietal/docma@pika/publishnamesakenizopengatomicboaropenmopen-on-npmmaster-inquisitor@kgryte/generator-node-module@kgryte/package-json@kylemh/npyargzf-npyo-helpernpm-name-checkernpm-name-clinpm-random-feednpm-validateavailable-npm-names@cyber-tools/create-cyber-library@cyber-tools/create-cyber-tools@cyber-tools/cyber-npmcheckpackagepkg-namedocmadiscordjs-con-selfconfusion-testgenerator-aliyun-buygenerator-appverse-gruntgenerator-assemble-skeletorgenerator-atomicboargenerator-babel-plugingenerator-baboongenerator-boilerplate-generatorgenerator-broccoligenerator-coffee-nodegenerator-coffeelintgenerator-compute-iogenerator-baregenerator-beargenerator-bearyhubotgenerator-client-side1a1vgenerator-devebotgenerator-distributions-iogenerator-doc-metrix-docgenerator-doc-metrix-nodecreate-packagecreate-gatsby-themecreate-lib-reactfnneverything-okreact-library-generatordext-core-utilsgenerator-sanji-framergenerator-sanji-uigenerator-sethgenerator-quicky@abhisekp/inquirer-npm-namegenerator-scrat-pagelet-koagenerator-sails-hookgenerator-shuttlecraftgenerator-simple-node-packagegenerator-steves-nodegenerator-validate-iogenerator-microjsgenerator-mini-packagegenerator-mini-restgenerator-mtb-appgenerator-nodestackgenerator-ntesmailgenerator-onereqgenerator-lx-modulegenerator-module-imweb
7.0.0

5 months ago

6.0.1

1 year ago

6.0.0

2 years ago

5.5.0

2 years ago

5.4.0

2 years ago

5.3.0

2 years ago

5.2.0

3 years ago

5.1.0

3 years ago

5.0.1

3 years ago

5.0.0

3 years ago

4.1.0

3 years ago

4.0.0

3 years ago

3.2.0

3 years ago

3.1.0

4 years ago

3.0.0

5 years ago

2.1.0

6 years ago

2.0.0

6 years ago

1.2.0

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.5

6 years ago

1.0.4

7 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago

0.2.0

7 years ago

0.1.1

7 years ago

0.1.0

7 years ago