Meta tweaks

.travis.yml

@@ -1,4 +1,5 @@
 language: node_js
 node_js:
+  - '12'
   - '10'
   - '8'

index.d.ts

@@ -13,7 +13,9 @@ declare namespace npmName {
 
 declare const npmName: {
 	/**
-	Check whether a package name is available (not registered) on npm.
+	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.
@@ -23,9 +25,19 @@ declare const npmName: {
 	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) {
@@ -40,7 +52,9 @@ declare const npmName: {
 	(name: string, options?: npmName.Options): Promise<boolean>;
 
 	/**
-	Check whether multiple package names are available (not registered) on npm.
+	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.
@@ -51,10 +65,13 @@ declare const npmName: {
 
 	(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
 	})();

index.js

@@ -10,7 +10,7 @@ const validate = require('validate-npm-package-name');
 class InvalidNameError extends Error {}
 
 const organizationRegex = /^@[a-z\d][\w-.]+\/?$/;
-const npmOrgUrl = 'https://www.npmjs.com/org/';
+const npmOrganizationUrl = 'https://www.npmjs.com/org/';
 
 const request = async (name, options) => {
 	const registryUrl = normalizeUrl(options.registryUrl || configuredRegistryUrl);
@@ -43,7 +43,7 @@ const request = async (name, options) => {
 
 	try {
 		if (isOrganization) {
-			await got.head(npmOrgUrl + name.toLowerCase(), {timeout: 10000});
+			await got.head(npmOrganizationUrl + name.toLowerCase(), {timeout: 10000});
 		} else {
 			await got.head(registryUrl + name.toLowerCase(), {timeout: 10000, headers});
 		}

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "npm-name",
 	"version": "5.4.0",
-	"description": "Check whether a package name is available on npm",
+	"description": "Check whether a package or organization name is available on npm",
 	"license": "MIT",
 	"repository": "sindresorhus/npm-name",
 	"author": {
@@ -23,6 +23,7 @@
 		"name",
 		"available",
 		"package",
+		"organization",
 		"npm",
 		"pkg",
 		"app",
@@ -31,17 +32,17 @@
 	],
 	"dependencies": {
 		"got": "^9.6.0",
-		"is-scoped": "^1.0.0",
+		"is-scoped": "^2.1.0",
 		"is-url-superb": "^3.0.0",
 		"lodash.zip": "^4.2.0",
-		"registry-auth-token": "^3.4.0",
-		"registry-url": "^4.0.0",
+		"registry-auth-token": "^4.0.0",
+		"registry-url": "^5.1.0",
 		"validate-npm-package-name": "^3.0.0"
 	},
 	"devDependencies": {
-		"ava": "^1.4.1",
+		"ava": "^2.1.0",
 		"tsd": "^0.7.1",
-		"unique-string": "^1.0.0",
+		"unique-string": "^2.0.0",
 		"xo": "^0.24.0"
 	}
 }

readme.md

@@ -1,6 +1,6 @@
 # npm-name [![Build Status](https://travis-ci.org/sindresorhus/npm-name.svg?branch=master)](https://travis-ci.org/sindresorhus/npm-name)
 
-> Check whether a package name is available on npm
+> Check whether a package or organization name is available on npm
 
 
 ## Install
@@ -16,22 +16,28 @@ $ npm install npm-name
 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
 
-	// Can also check whether an organization name is available
-	// Organization names should start with @ and should not be a scoped package
-	console.log(await npmName('@ava'));
-	//=> false
-	console.log(await npmName('@abc123'));
+	console.log(result.get('abc123'));
 	//=> true
 
 	try {
@@ -50,6 +56,10 @@ const npmName = require('npm-name');
 
 ### 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
@@ -72,6 +82,8 @@ Registry URL to check name availability against.
 
 ### 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
@@ -90,8 +102,3 @@ Same as `npmName()`.
 ## Related
 
 - [npm-name-cli](https://github.com/sindresorhus/npm-name-cli) - CLI for this module
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)

test.js

@@ -13,7 +13,7 @@ test('returns true when package name is available', async t => {
 	await t.throwsAsync(npmName(moduleName, {registryUrl: null}));
 });
 
-test('returns true when org name is available', async t => {
+test('returns true when organization name is available', async t => {
 	const moduleName = uniqueString();
 
 	t.true(await npmName(`@${moduleName}`));
@@ -26,7 +26,7 @@ test('returns false when package name is taken', async t => {
 	t.false(await npmName('np', options));
 });
 
-test('returns false when org name is taken', async t => {
+test('returns false when organization name is taken', async t => {
 	t.false(await npmName('@ava'));
 	t.false(await npmName('@ava/'));
 	t.false(await npmName('@angular/'));