index.d.ts

declare class InvalidNameErrorClass extends Error {}

declare namespace npmName {
	interface Options {
		/**
		Registry URL to check name availability against.

		Default: User's configured npm registry URL.
		*/
		readonly registryUrl: string;
	}
}

declare const npmName: {
	/**
	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.

	@param name - Name to check.
	@returns Whether the given name is available.

	@example
	```
	import 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


		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
		}
	})();
	```
	*/
	(name: string, options?: npmName.Options): Promise<boolean>;

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

	An organization name should start with `@` and should not be a scoped package.

	@param names - Multiple names to check.
	@returns A `Map` of name and status.

	@example
	```
	import npmName = require('npm-name');

	(async () => {
		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
	})();
	```
	*/
	many<NameType extends string>(
		names: NameType[],
		options?: npmName.Options
	): Promise<Map<NameType, boolean>>;

	InvalidNameError: typeof InvalidNameErrorClass;
};

export = npmName;