Refactor TypeScript definition to CommonJS compatible export (#34)

index.d.ts

@@ -1,21 +1,62 @@
+declare class InvalidNameErrorClass extends Error {}
+
 declare const npmName: {
 	/**
-	 * Check whether a package name is available (not registered) on npm.
-	 *
-	 * @param name - Name to check.
-	 * @returns Whether the given name is available.
-	 */
+	Check whether a package name is available (not registered) on npm.
+
+	@param name - Name to check.
+	@returns Whether the given name is available.
+
+	@example
+	```
+	import npmName = require('npm-name');
+
+	(async () => {
+		console.log(await npmName('chalk'));
+		//=> false
+
+		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): Promise<boolean>;
 
 	/**
-	 * Check whether multiple package names are available (not registered) on npm.
-	 *
-	 * @param names - Multiple names to check.
-	 * @returns A `Map` of name and status.
-	 */
-	many<NameType extends string>(names: NameType[]): Promise<Map<NameType, boolean>>;
-};
+	Check whether multiple package names are available (not registered) on npm.
 
-export default npmName;
+	@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[]
+	): Promise<Map<NameType, boolean>>;
+
+	InvalidNameError: typeof InvalidNameErrorClass;
+
+	// TODO: remove this in the next major version
+	default: typeof npmName;
+};
 
-export class InvalidNameError extends Error {}
+export = npmName;

index.js

@@ -55,6 +55,7 @@ const npmName = name => {
 };
 
 module.exports = npmName;
+// TODO: remove this in the next major version
 module.exports.default = npmName;
 
 module.exports.many = async names => {

index.test-d.ts

@@ -1,5 +1,6 @@
-import {expectType} from 'tsd-check';
-import npmName, {InvalidNameError} from '.';
+import {expectType} from 'tsd';
+import npmName = require('.');
+import {InvalidNameError} from '.';
 
 expectType<Promise<boolean>>(npmName('chalk'));
 
@@ -9,4 +10,4 @@ expectType<Promise<Map<'chalk' | '@sindresorhus/is' | 'abc123', boolean>>>(
 );
 expectType<boolean | undefined>((await manyResult).get('chalk'));
 
-expectType<typeof InvalidNameError>(InvalidNameError);
+new InvalidNameError('foo') instanceof InvalidNameError;

package.json

@@ -13,7 +13,7 @@
 		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd-check"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -33,13 +33,13 @@
 		"got": "^9.6.0",
 		"is-scoped": "^1.0.0",
 		"lodash.zip": "^4.2.0",
-		"registry-auth-token": "^3.3.2",
+		"registry-auth-token": "^3.4.0",
 		"registry-url": "^4.0.0",
 		"validate-npm-package-name": "^3.0.0"
 	},
 	"devDependencies": {
-		"ava": "^1.3.1",
-		"tsd-check": "^0.3.0",
+		"ava": "^1.4.1",
+		"tsd": "^0.7.1",
 		"unique-string": "^1.0.0",
 		"xo": "^0.24.0"
 	}