Meta tweaks

sindresorhus · Mar 10, 2019 · c399148 · c399148
1 parent 3a7320f
commit c399148
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -3,15 +3,15 @@ declare const npmName: {
 	 * Check whether a package name is available (not registered) on npm.
 	 *
 	 * @param name - Name to check.
-	 * @returns Whether a name is available.
+	 * @returns Whether the given name is available.
 	 */
 	(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/status.
+	 * @returns A `Map` of name and status.
 	 */
 	many<NameType extends string>(names: NameType[]): Promise<Map<NameType, boolean>>;
 };

diff --git a/readme.md b/readme.md
@@ -43,7 +43,7 @@ const npmName = require('npm-name');
 
 ### npmName(name)
 
-Returns a promise for a boolean.
+Returns a `Promise<boolean>` of whether the given name is available.
 
 #### name
 
@@ -53,7 +53,7 @@ Name to check.
 
 ### npmName.many(names)
 
-Returns a promise for a `Map` of name/status.
+Returns a `Promise<Map>` of name and status.
 
 #### names