@common.js/p-timeout 6.1.3 → 7.0.1

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.3](https://www.npmjs.com/package/p-timeout/v/6.1.3) using https://github.com/etienne-martin/common.js.
+Exported from [p-timeout@7.0.1](https://www.npmjs.com/package/p-timeout/v/7.0.1) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -1,6 +1,6 @@
 export class TimeoutError extends Error {
 	readonly name: 'TimeoutError';
-	constructor(message?: string);
+	constructor(message?: string, options?: ErrorOptions);
 }
 
 export type ClearablePromise<T> = {
@@ -92,9 +92,7 @@ export type Options<ReturnType> = {
 	};
 
 	/**
-	You can abort the promise using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
-
-	_Requires Node.js 16 or later._
+	Abort the promise.
 
 	@example
 	```

package/index.js

@@ -12,9 +12,6 @@ _export(exports, {
     TimeoutError: function() {
         return TimeoutError;
     },
-    AbortError: function() {
-        return AbortError;
-    },
     default: function() {
         return pTimeout;
     }
@@ -25,35 +22,6 @@ function _assertThisInitialized(self) {
     }
     return self;
 }
-function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
-    try {
-        var info = gen[key](arg);
-        var value = info.value;
-    } catch (error) {
-        reject(error);
-        return;
-    }
-    if (info.done) {
-        resolve(value);
-    } else {
-        Promise.resolve(value).then(_next, _throw);
-    }
-}
-function _asyncToGenerator(fn) {
-    return function() {
-        var self = this, args = arguments;
-        return new Promise(function(resolve, reject) {
-            var gen = fn.apply(self, args);
-            function _next(value) {
-                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
-            }
-            function _throw(err) {
-                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
-            }
-            _next(undefined);
-        });
-    };
-}
 function _classCallCheck(instance, Constructor) {
     if (!(instance instanceof Constructor)) {
         throw new TypeError("Cannot call a class as a function");
@@ -87,6 +55,19 @@ function _construct(Parent, args, Class) {
     }
     return _construct.apply(null, arguments);
 }
+function _defineProperty(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
 function _getPrototypeOf(o) {
     _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) {
         return o.__proto__ || Object.getPrototypeOf(o);
@@ -183,170 +164,57 @@ function _createSuper(Derived) {
         return _possibleConstructorReturn(this, result);
     };
 }
-var __generator = (void 0) && (void 0).__generator || function(thisArg, body) {
-    var f, y, t, g, _ = {
-        label: 0,
-        sent: function() {
-            if (t[0] & 1) throw t[1];
-            return t[1];
-        },
-        trys: [],
-        ops: []
-    };
-    return g = {
-        next: verb(0),
-        "throw": verb(1),
-        "return": verb(2)
-    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
-        return this;
-    }), g;
-    function verb(n) {
-        return function(v) {
-            return step([
-                n,
-                v
-            ]);
-        };
-    }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while(_)try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [
-                op[0] & 2,
-                t.value
-            ];
-            switch(op[0]){
-                case 0:
-                case 1:
-                    t = op;
-                    break;
-                case 4:
-                    _.label++;
-                    return {
-                        value: op[1],
-                        done: false
-                    };
-                case 5:
-                    _.label++;
-                    y = op[1];
-                    op = [
-                        0
-                    ];
-                    continue;
-                case 7:
-                    op = _.ops.pop();
-                    _.trys.pop();
-                    continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
-                        _ = 0;
-                        continue;
-                    }
-                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
-                        _.label = op[1];
-                        break;
-                    }
-                    if (op[0] === 6 && _.label < t[1]) {
-                        _.label = t[1];
-                        t = op;
-                        break;
-                    }
-                    if (t && _.label < t[2]) {
-                        _.label = t[2];
-                        _.ops.push(op);
-                        break;
-                    }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop();
-                    continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) {
-            op = [
-                6,
-                e
-            ];
-            y = 0;
-        } finally{
-            f = t = 0;
-        }
-        if (op[0] & 5) throw op[1];
-        return {
-            value: op[0] ? op[1] : void 0,
-            done: true
-        };
-    }
-};
 var TimeoutError = /*#__PURE__*/ function(Error1) {
     "use strict";
     _inherits(TimeoutError, Error1);
     var _super = _createSuper(TimeoutError);
-    function TimeoutError(message) {
+    function TimeoutError(message, options) {
         _classCallCheck(this, TimeoutError);
         var _this;
-        _this = _super.call(this, message);
-        _this.name = "TimeoutError";
+        var ref;
+        _this = _super.call(this, message, options);
+        _defineProperty(_assertThisInitialized(_this), "name", "TimeoutError");
+        (ref = Error.captureStackTrace) === null || ref === void 0 ? void 0 : ref.call(Error, _assertThisInitialized(_this), TimeoutError);
         return _this;
     }
     return TimeoutError;
 }(_wrapNativeSuper(Error));
-var AbortError = /*#__PURE__*/ function(Error1) {
-    "use strict";
-    _inherits(AbortError, Error1);
-    var _super = _createSuper(AbortError);
-    function AbortError(message) {
-        _classCallCheck(this, AbortError);
-        var _this;
-        _this = _super.call(this);
-        _this.name = "AbortError";
-        _this.message = message;
-        return _this;
-    }
-    return AbortError;
-}(_wrapNativeSuper(Error));
-/**
-TODO: Remove AbortError and just throw DOMException when targeting Node 18.
-*/ var getDOMException = function(errorMessage) {
-    return globalThis.DOMException === undefined ? new AbortError(errorMessage) : new DOMException(errorMessage);
-};
-/**
-TODO: Remove below function and just 'reject(signal.reason)' when targeting Node 18.
-*/ var getAbortedReason = function(signal) {
-    var reason = signal.reason === undefined ? getDOMException("This operation was aborted.") : signal.reason;
-    return _instanceof(reason, Error) ? reason : getDOMException(reason);
+var _reason;
+var getAbortedReason = function(signal) {
+    return (_reason = signal.reason) !== null && _reason !== void 0 ? _reason : new DOMException("This operation was aborted.", "AbortError");
 };
 function pTimeout(promise, options) {
     var milliseconds = options.milliseconds, fallback = options.fallback, message = options.message, _customTimers = options.customTimers, customTimers = _customTimers === void 0 ? {
         setTimeout: setTimeout,
         clearTimeout: clearTimeout
-    } : _customTimers;
+    } : _customTimers, signal = options.signal;
     var timer;
+    var abortHandler;
     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 (options.signal) {
-            var signal = options.signal;
-            if (signal.aborted) {
-                reject(getAbortedReason(signal));
-            }
-            var abortHandler = function() {
+        if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+            reject(getAbortedReason(signal));
+            return;
+        }
+        if (signal) {
+            abortHandler = function() {
                 reject(getAbortedReason(signal));
             };
             signal.addEventListener("abort", abortHandler, {
                 once: true
             });
-            promise.finally(function() {
-                signal.removeEventListener("abort", abortHandler);
-            });
         }
+        // Use .then() instead of async IIFE to preserve stack traces
+        // eslint-disable-next-line promise/prefer-await-to-then, promise/prefer-catch
+        promise.then(resolve, reject);
         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();
+        // `.call(undefined, ...)` is needed for custom timers to avoid context issues
         timer = customTimers.setTimeout.call(undefined, function() {
             if (fallback) {
                 try {
@@ -368,48 +236,16 @@ function pTimeout(promise, options) {
                 reject(timeoutError);
             }
         }, milliseconds);
-        _asyncToGenerator(function() {
-            var error;
-            return __generator(this, function(_state) {
-                switch(_state.label){
-                    case 0:
-                        _state.trys.push([
-                            0,
-                            2,
-                            ,
-                            3
-                        ]);
-                        return [
-                            4,
-                            promise
-                        ];
-                    case 1:
-                        resolve.apply(void 0, [
-                            _state.sent()
-                        ]);
-                        return [
-                            3,
-                            3
-                        ];
-                    case 2:
-                        error = _state.sent();
-                        reject(error);
-                        return [
-                            3,
-                            3
-                        ];
-                    case 3:
-                        return [
-                            2
-                        ];
-                }
-            });
-        })();
     });
+    // eslint-disable-next-line promise/prefer-await-to-then
     var cancelablePromise = wrappedPromise.finally(function() {
         cancelablePromise.clear();
+        if (abortHandler && signal) {
+            signal.removeEventListener("abort", abortHandler);
+        }
     });
     cancelablePromise.clear = function() {
+        // `.call(undefined, ...)` is needed for custom timers to avoid context issues
         customTimers.clearTimeout.call(undefined, timer);
         timer = undefined;
     };

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@common.js/p-timeout",
-  "version": "6.1.3",
+  "version": "7.0.1",
   "description": "p-timeout package exported as CommonJS modules",
   "license": "MIT",
   "repository": "etienne-martin/common.js",
   "funding": "https://github.com/sponsors/sindresorhus",
   "type": "commonjs",
-  "types": "./index.d.ts",
   "sideEffects": false,
   "engines": {
-    "node": ">=14.16"
+    "node": ">=20"
   },
   "scripts": {
     "test": "xo && ava && tsd"
@@ -19,16 +18,17 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "ava": "^4.3.1",
-    "delay": "^5.0.0",
+    "ava": "^6.4.1",
+    "delay": "^6.0.0",
     "in-range": "^3.0.0",
     "p-cancelable": "^4.0.1",
-    "sinon": "^19.0.2",
+    "sinon": "^21.0.0",
     "time-span": "^5.1.0",
-    "tsd": "^0.22.0",
-    "xo": "^0.54.2"
+    "tsd": "^0.33.0",
+    "xo": "^1.2.2"
   },
   "homepage": "https://github.com/etienne-martin/common.js#readme",
   "dependencies": {},
-  "main": "./index.js"
+  "main": "./index.js",
+  "types": "./index.d.ts"
 }