@common.js/p-timeout 6.1.0 → 6.1.2

package/README.md

@@ -2,4 +2,4 @@
 
 The [p-timeout](https://www.npmjs.com/package/p-timeout) package exported as CommonJS modules.
 
-Exported from [p-timeout@6.1.0](https://www.npmjs.com/package/p-timeout/v/6.1.0) using https://github.com/etienne-martin/common.js.
+Exported from [p-timeout@6.1.2](https://www.npmjs.com/package/p-timeout/v/6.1.2) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -3,12 +3,12 @@ export class TimeoutError extends Error {
 	constructor(message?: string);
 }
 
-export interface ClearablePromise<T> extends Promise<T> {
+export type ClearablePromise<T> = {
 	/**
 	Clear the timeout.
 	*/
 	clear: () => void;
-}
+} & Promise<T>;
 
 export type Options<ReturnType> = {
 	/**
@@ -136,7 +136,7 @@ const delayedPromise = () => setTimeout(200);
 await pTimeout(delayedPromise(), {
 	milliseconds: 50,
 	fallback: () => {
-		return pTimeout(delayedPromise(), 300);
+		return pTimeout(delayedPromise(), {milliseconds: 300});
 	}
 });
 ```

package/index.js

@@ -322,14 +322,10 @@ function pTimeout(promise, options) {
         clearTimeout: clearTimeout
     } : _customTimers;
     var timer;
-    var cancelablePromise = new Promise(function(resolve, reject) {
+    var wrappedPromise = new Promise(function(resolve, reject) {
         if (typeof milliseconds !== "number" || Math.sign(milliseconds) !== 1) {
             throw new TypeError("Expected `milliseconds` to be a positive number, got `".concat(milliseconds, "`"));
         }
-        if (milliseconds === Number.POSITIVE_INFINITY) {
-            resolve(promise);
-            return;
-        }
         if (options.signal) {
             var signal = options.signal;
             if (signal.aborted) {
@@ -339,6 +335,12 @@ function pTimeout(promise, options) {
                 reject(getAbortedReason(signal));
             });
         }
+        if (milliseconds === Number.POSITIVE_INFINITY) {
+            promise.then(resolve, reject);
+            return;
+        }
+        // We create the error outside of `setTimeout` to preserve the stack trace.
+        var timeoutError = new TimeoutError();
         timer = customTimers.setTimeout.call(undefined, function() {
             if (fallback) {
                 try {
@@ -356,8 +358,8 @@ function pTimeout(promise, options) {
             } else if (_instanceof(message, Error)) {
                 reject(message);
             } else {
-                var errorMessage = message !== null && message !== void 0 ? message : "Promise timed out after ".concat(milliseconds, " milliseconds");
-                reject(new TimeoutError(errorMessage));
+                timeoutError.message = message !== null && message !== void 0 ? message : "Promise timed out after ".concat(milliseconds, " milliseconds");
+                reject(timeoutError);
             }
         }, milliseconds);
         _asyncToGenerator(function() {
@@ -368,8 +370,8 @@ function pTimeout(promise, options) {
                         _state.trys.push([
                             0,
                             2,
-                            3,
-                            4
+                            ,
+                            3
                         ]);
                         return [
                             4,
@@ -381,21 +383,16 @@ function pTimeout(promise, options) {
                         ]);
                         return [
                             3,
-                            4
+                            3
                         ];
                     case 2:
                         error = _state.sent();
                         reject(error);
                         return [
                             3,
-                            4
+                            3
                         ];
                     case 3:
-                        customTimers.clearTimeout.call(undefined, timer);
-                        return [
-                            7
-                        ];
-                    case 4:
                         return [
                             2
                         ];
@@ -403,6 +400,9 @@ function pTimeout(promise, options) {
             });
         })();
     });
+    var cancelablePromise = wrappedPromise.finally(function() {
+        cancelablePromise.clear();
+    });
     cancelablePromise.clear = function() {
         customTimers.clearTimeout.call(undefined, timer);
         timer = undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@common.js/p-timeout",
-  "version": "6.1.0",
+  "version": "6.1.2",
   "description": "p-timeout package exported as CommonJS modules",
   "license": "MIT",
   "repository": "etienne-martin/common.js",
@@ -24,7 +24,7 @@
     "p-cancelable": "^4.0.1",
     "time-span": "^5.1.0",
     "tsd": "^0.22.0",
-    "xo": "^0.51.0"
+    "xo": "^0.54.2"
   },
   "homepage": "https://github.com/etienne-martin/common.js#readme",
   "dependencies": {},