npm-name
Check whether a package or organization name is available on npm
Last updated 20 days ago by sindresorhus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install npm-name 
SYNC missed versions from official npm registry.

npm-name Build Status

Check whether a package or organization name is available on npm

Install

$ npm install npm-name

Usage

const npmName = require('npm-name');

(async () => {
	// 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


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

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

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

	console.log(result.get('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.

npmName.many(names, options?)

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

Returns a Promise<Map> of name and status.

names

Type: string[]

Multiple names to check.

options

Type: object

Same as npmName().

Related

Current Tags

  • 6.0.1                                ...           latest (20 days ago)

28 Versions

  • 6.0.1                                ...           20 days ago
  • 6.0.0                                ...           5 months ago
  • 5.5.0                                ...           a year ago
  • 5.4.0                                ...           a year ago
  • 5.3.0                                ...           a year ago
  • 5.2.0                                ...           a year ago
  • 5.1.0                                ...           a year ago
  • 5.0.1                                ...           2 years ago
  • 5.0.0                                ...           2 years ago
  • 4.1.0                                ...           2 years ago
  • 4.0.0                                ...           2 years ago
  • 3.2.0                                ...           2 years ago
  • 3.1.0                                ...           3 years ago
  • 3.0.0                                ...           4 years ago
  • 2.1.0                                ...           5 years ago
  • 2.0.0                                ...           5 years ago
  • 1.2.0                                ...           5 years ago
  • 1.1.1                                ...           5 years ago
  • 1.1.0                                ...           5 years ago
  • 1.0.5                                ...           5 years ago
  • 1.0.4                                ...           5 years ago
  • 1.0.3                                ...           5 years ago
  • 1.0.2                                ...           6 years ago
  • 1.0.1                                ...           6 years ago
  • 1.0.0                                ...           6 years ago
  • 0.2.0                                ...           6 years ago
  • 0.1.1                                ...           6 years ago
  • 0.1.0                                ...           6 years ago
Maintainers (1)
Downloads
Today 28
This Week 601
This Month 2,245
Last Day 123
Last Week 1,017
Last Month 5,997
Dependencies (9)
Dev Dependencies (5)
Dependents (166)

Copyright 2014 - 2016 © taobao.org |