p-try - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

index.d.ts

@@ -1,27 +0,39 @@
-/**
-Start a promise chain.
+declare const pTry: {
+	/**
+	Start a promise chain.
 
-@param fn - The function to run to start the promise chain.
-@param arguments - Arguments to pass to `fn`.
-@returns The value of calling `fn(...arguments)`. If the function throws an error, the returned `Promise` will be rejected with that error.
+	@param fn - The function to run to start the promise chain.
+	@param arguments - Arguments to pass to `fn`.
+	@returns The value of calling `fn(...arguments)`. If the function throws an error, the returned `Promise` will be rejected with that error.
 
-@example
-```
-import pTry from 'p-try';
+	@example
+	```
+	import pTry = require('p-try');
 
-(async () => {
-	try {
-		const value = await pTry(() => {
-			return synchronousFunctionThatMightThrow();
-		});
-		console.log(value);
-	} catch (error) {
-		console.error(error);
-	}
-})();
-```
-*/
-export default function pTry<ValueType, ArgumentsType extends unknown[]>(
-	fn: (...arguments: ArgumentsType) => PromiseLike<ValueType> | ValueType,
-	...arguments: ArgumentsType
-): Promise<ValueType>;
+	(async () => {
+		try {
+			const value = await pTry(() => {
+				return synchronousFunctionThatMightThrow();
+			});
+			console.log(value);
+		} catch (error) {
+			console.error(error);
+		}
+	})();
+	```
+	*/
+	<ValueType, ArgumentsType extends unknown[]>(
+		fn: (...arguments: ArgumentsType) => PromiseLike<ValueType> | ValueType,
+		...arguments: ArgumentsType
+	): Promise<ValueType>;
+
+	// TODO: remove this in the next major version, refactor the whole definition to:
+	// declare function pTry<ValueType, ArgumentsType extends unknown[]>(
+	//	fn: (...arguments: ArgumentsType) => PromiseLike<ValueType> | ValueType,
+	//	...arguments: ArgumentsType
+	// ): Promise<ValueType>;
+	// export = pTry;
+	default: typeof pTry;
+};
+
+export = pTry;

index.js

@@ -8,2 +8,3 @@ 'use strict';
 module.exports = pTry;
+// TODO: remove this in the next major version
 module.exports.default = pTry;

package.json

 {
 	"name": "p-try",
-	"version": "2.1.0",
+	"version": "2.2.0",
 	"description": "`Start a promise chain",
@@ -16,3 +16,3 @@ "license": "MIT",
 	"scripts": {
-		"test": "xo && ava && tsd-check"
+		"test": "xo && ava && tsd"
 	},
@@ -39,6 +39,6 @@ "files": [
 	"devDependencies": {
-		"ava": "^1.3.1",
-		"tsd-check": "^0.5.0",
+		"ava": "^1.4.1",
+		"tsd": "^0.7.1",
 		"xo": "^0.24.0"
 	}
 }

No alert changes

Improved metrics

Total package byte prevSize

4371

increased by10.38%

Lines of code

41

increased by36.67%

No dependency changes