Meta tweaks

sindresorhus · sindresorhus · commit bebd12e2893a · 2019-03-11T20:41:41.000+07:00
diff --git a/index.d.ts b/index.d.ts
@@ -1,4 +1,4 @@
-export interface UserData {
+export interface UserInfo {
 	/**
 	 * User's name.
 	 */
@@ -20,7 +20,7 @@ export interface UserData {
 	github: string | null;
 
 	/**
-	 * User's associated twitter account.
+	 * User's associated Twitter account.
 	 */
 	twitter: string | null;
 }
@@ -30,4 +30,4 @@ export interface UserData {
  *
  * @param name - User's username on npm.
  */
-export default function npmUser(name: string): Promise<UserData>;
+export default function npmUser(name: string): Promise<UserInfo>;
diff --git a/index.js b/index.js
@@ -5,16 +5,13 @@ const npmEmail = require('npm-email');
 
 const npmUser = async username => {
 	if (typeof username !== 'string') {
-		return Promise.reject(new Error('Username required'));
+		throw new TypeError('Username required');
 	}
 
 	const url = `https://www.npmjs.com/~${username}`;
 	try {
-		const values = await Promise.all([got(url), npmEmail(username)]);
-
-		const res = values[0];
-		const email = values[1];
-		const $ = cheerio.load(res.body);
+		const [profile, email] = await Promise.all([got(url), npmEmail(username)]);
+		const $ = cheerio.load(profile.body);
 
 		let avatar = $('img[src^="https://s.gravatar.com"]').attr('src');
 		avatar = avatar ? avatar.replace(/^(https:\/\/)s\./, '$1').replace(/&default=retro$/, '') : null;
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -1,12 +1,12 @@
 import {expectType} from 'tsd-check';
-import npmUser, {UserData} from '.';
+import npmUser, {UserInfo} from '.';
 
-const userDataPromise = npmUser('sindresorhus');
-expectType<Promise<UserData>>(userDataPromise);
+const userInfoPromise = npmUser('sindresorhus');
+expectType<Promise<UserInfo>>(userInfoPromise);
 
-const userData = await userDataPromise;
-expectType<string | null>(userData.name);
-expectType<string | null>(userData.avatar);
-expectType<string | null>(userData.email);
-expectType<string | null>(userData.github);
-expectType<string | null>(userData.twitter);
+const userInfo = await userInfoPromise;
+expectType<string | null>(userInfo.name);
+expectType<string | null>(userInfo.avatar);
+expectType<string | null>(userInfo.email);
+expectType<string | null>(userInfo.github);
+expectType<string | null>(userInfo.twitter);
diff --git a/readme.md b/readme.md
@@ -4,7 +4,7 @@
 
 Since npm has no API for this we're forced to scrape the [profile page](https://www.npmjs.com/~sindresorhus).
 
-*Use the faster [npm-email](https://github.com/sindresorhus/npm-email) if you only need the email.*
+*Use the faster [npm-email](https://github.com/sindresorhus/npm-email) package if you only need the email.*
 
 
 ## Install
@@ -19,8 +19,8 @@ $ npm install npm-user
 ```js
 const npmUser = require('npm-user');
 
-npmUser('sindresorhus').then(user => {
-	console.log(user);
+(async () => {
+	console.log(await npmUser('sindresorhus'));
 	/*
 	{
 		name: 'Sindre Sorhus',
@@ -30,7 +30,7 @@ npmUser('sindresorhus').then(user => {
 		twitter: 'sindresorhus'
 	}
 	*/
-});
+})()
 ```
 
 *Values will be `null` if they're not set in the npm profile.*
