Check whether a package name is available on npm


Keywords
name, available, package, npm, pkg, app, check, taken
License
MIT
Install
npm install npm-name@5.0.0

Documentation

npm-name Build Status

Check whether a package name is available on npm

Install

$ npm install npm-name

Usage

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

(async () => {
	console.log(await npmName('chalk'));
	// false

	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)

Returns a promise for a boolean.

name

Type: String

Name to check.

npmName.many(names)

Returns a promise for a Map of name/status.

names

Type: Array

Multiple names to check.

Related

License

MIT © Sindre Sorhus