@common.js/p-timeout 5.1.0

package/README.md

@@ -0,0 +1,5 @@
+# @common.js/p-timeout
+
+The [p-timeout](https://www.npmjs.com/package/p-timeout) package exported as CommonJS modules.
+
+Exported from [p-timeout@5.1.0](https://www.npmjs.com/package/p-timeout/v/5.1.0) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -0,0 +1,126 @@
+/* eslint-disable import/export */
+
+export class TimeoutError extends Error {
+	readonly name: 'TimeoutError';
+	constructor(message?: string);
+}
+
+export interface ClearablePromise<T> extends Promise<T>{
+	/**
+	Clear the timeout.
+	*/
+	clear: () => void;
+}
+
+export type Options = {
+	/**
+	Custom implementations for the `setTimeout` and `clearTimeout` functions.
+
+	Useful for testing purposes, in particular to work around [`sinon.useFakeTimers()`](https://sinonjs.org/releases/latest/fake-timers/).
+
+	@example
+	```
+	import pTimeout from 'p-timeout';
+	import sinon from 'sinon';
+
+	const originalSetTimeout = setTimeout;
+	const originalClearTimeout = clearTimeout;
+
+	sinon.useFakeTimers();
+
+	// Use `pTimeout` without being affected by `sinon.useFakeTimers()`:
+	await pTimeout(doSomething(), 2000, undefined, {
+		customTimers: {
+			setTimeout: originalSetTimeout,
+			clearTimeout: originalClearTimeout
+		}
+	});
+	```
+	*/
+	readonly customTimers?: {
+		setTimeout: typeof global.setTimeout;
+		clearTimeout: typeof global.clearTimeout;
+	};
+
+	/**
+	You can abort the promise using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+
+	_Requires Node.js 16 or later._
+
+	@example
+	```
+	import pTimeout from 'p-timeout';
+	import delay from 'delay';
+
+	const delayedPromise = delay(3000);
+
+	const abortController = new AbortController();
+
+	setTimeout(() => {
+		abortController.abort();
+	}, 100);
+
+	await pTimeout(delayedPromise, 2000, undefined, {
+		signal: abortController.signal
+	});
+	```
+	*/
+	signal?: globalThis.AbortSignal;
+};
+
+/**
+Timeout a promise after a specified amount of time.
+
+If you pass in a cancelable promise, specifically a promise with a `.cancel()` method, that method will be called when the `pTimeout` promise times out.
+
+@param input - Promise to decorate.
+@param milliseconds - Milliseconds before timing out.
+@param message - Specify a custom error message or error. If you do a custom error, it's recommended to sub-class `pTimeout.TimeoutError`. Default: `'Promise timed out after 50 milliseconds'`.
+@returns A decorated `input` that times out after `milliseconds` time. It has a `.clear()` method that clears the timeout.
+
+@example
+```
+import {setTimeout} from 'timers/promises';
+import pTimeout from 'p-timeout';
+
+const delayedPromise = setTimeout(200);
+
+await pTimeout(delayedPromise, 50);
+//=> [TimeoutError: Promise timed out after 50 milliseconds]
+```
+*/
+export default function pTimeout<ValueType>(
+	input: PromiseLike<ValueType>,
+	milliseconds: number,
+	message?: string | Error,
+	options?: Options
+): ClearablePromise<ValueType>;
+
+/**
+Timeout a promise after a specified amount of time.
+
+If you pass in a cancelable promise, specifically a promise with a `.cancel()` method, that method will be called when the `pTimeout` promise times out.
+
+@param input - Promise to decorate.
+@param milliseconds - Milliseconds before timing out. Passing `Infinity` will cause it to never time out.
+@param fallback - Do something other than rejecting with an error on timeout. You could for example retry.
+@returns A decorated `input` that times out after `milliseconds` time. It has a `.clear()` method that clears the timeout.
+
+@example
+```
+import {setTimeout} from 'timers/promises';
+import pTimeout from 'p-timeout';
+
+const delayedPromise = () => setTimeout(200);
+
+await pTimeout(delayedPromise(), 50, () => {
+	return pTimeout(delayedPromise(), 300);
+});
+```
+*/
+export default function pTimeout<ValueType, ReturnType>(
+	input: PromiseLike<ValueType>,
+	milliseconds: number,
+	fallback: () => ReturnType | Promise<ReturnType>,
+	options?: Options
+): ClearablePromise<ValueType | ReturnType>;

package/index.js

@@ -0,0 +1,436 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    TimeoutError: function() {
+        return TimeoutError;
+    },
+    AbortError: function() {
+        return AbortError;
+    },
+    default: function() {
+        return pTimeout;
+    }
+});
+function _assertThisInitialized(self) {
+    if (self === void 0) {
+        throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
+    }
+    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");
+    }
+}
+function isNativeReflectConstruct() {
+    if (typeof Reflect === "undefined" || !Reflect.construct) return false;
+    if (Reflect.construct.sham) return false;
+    if (typeof Proxy === "function") return true;
+    try {
+        Date.prototype.toString.call(Reflect.construct(Date, [], function() {}));
+        return true;
+    } catch (e) {
+        return false;
+    }
+}
+function _construct(Parent, args, Class) {
+    if (isNativeReflectConstruct()) {
+        _construct = Reflect.construct;
+    } else {
+        _construct = function _construct(Parent, args, Class) {
+            var a = [
+                null
+            ];
+            a.push.apply(a, args);
+            var Constructor = Function.bind.apply(Parent, a);
+            var instance = new Constructor();
+            if (Class) _setPrototypeOf(instance, Class.prototype);
+            return instance;
+        };
+    }
+    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);
+    };
+    return _getPrototypeOf(o);
+}
+function _inherits(subClass, superClass) {
+    if (typeof superClass !== "function" && superClass !== null) {
+        throw new TypeError("Super expression must either be null or a function");
+    }
+    subClass.prototype = Object.create(superClass && superClass.prototype, {
+        constructor: {
+            value: subClass,
+            writable: true,
+            configurable: true
+        }
+    });
+    if (superClass) _setPrototypeOf(subClass, superClass);
+}
+function _instanceof(left, right) {
+    if (right != null && typeof Symbol !== "undefined" && right[Symbol.hasInstance]) {
+        return !!right[Symbol.hasInstance](left);
+    } else {
+        return left instanceof right;
+    }
+}
+function _isNativeFunction(fn) {
+    return Function.toString.call(fn).indexOf("[native code]") !== -1;
+}
+function _objectSpread(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
+        }
+        ownKeys.forEach(function(key) {
+            _defineProperty(target, key, source[key]);
+        });
+    }
+    return target;
+}
+function _possibleConstructorReturn(self, call) {
+    if (call && (_typeof(call) === "object" || typeof call === "function")) {
+        return call;
+    }
+    return _assertThisInitialized(self);
+}
+function _setPrototypeOf(o, p) {
+    _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) {
+        o.__proto__ = p;
+        return o;
+    };
+    return _setPrototypeOf(o, p);
+}
+var _typeof = function(obj) {
+    "@swc/helpers - typeof";
+    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
+};
+function _wrapNativeSuper(Class) {
+    var _cache = typeof Map === "function" ? new Map() : undefined;
+    _wrapNativeSuper = function _wrapNativeSuper(Class) {
+        if (Class === null || !_isNativeFunction(Class)) return Class;
+        if (typeof Class !== "function") {
+            throw new TypeError("Super expression must either be null or a function");
+        }
+        if (typeof _cache !== "undefined") {
+            if (_cache.has(Class)) return _cache.get(Class);
+            _cache.set(Class, Wrapper);
+        }
+        function Wrapper() {
+            return _construct(Class, arguments, _getPrototypeOf(this).constructor);
+        }
+        Wrapper.prototype = Object.create(Class.prototype, {
+            constructor: {
+                value: Wrapper,
+                enumerable: false,
+                writable: true,
+                configurable: true
+            }
+        });
+        return _setPrototypeOf(Wrapper, Class);
+    };
+    return _wrapNativeSuper(Class);
+}
+function _isNativeReflectConstruct() {
+    if (typeof Reflect === "undefined" || !Reflect.construct) return false;
+    if (Reflect.construct.sham) return false;
+    if (typeof Proxy === "function") return true;
+    try {
+        Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function() {}));
+        return true;
+    } catch (e) {
+        return false;
+    }
+}
+function _createSuper(Derived) {
+    var hasNativeReflectConstruct = _isNativeReflectConstruct();
+    return function _createSuperInternal() {
+        var Super = _getPrototypeOf(Derived), result;
+        if (hasNativeReflectConstruct) {
+            var NewTarget = _getPrototypeOf(this).constructor;
+            result = Reflect.construct(Super, arguments, NewTarget);
+        } else {
+            result = Super.apply(this, arguments);
+        }
+        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) {
+        _classCallCheck(this, TimeoutError);
+        var _this;
+        _this = _super.call(this, message);
+        _this.name = "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);
+};
+function pTimeout(promise, milliseconds, fallback, options) {
+    var timer;
+    var cancelablePromise = 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;
+        }
+        options = _objectSpread({
+            customTimers: {
+                setTimeout: setTimeout,
+                clearTimeout: clearTimeout
+            }
+        }, options);
+        if (options.signal) {
+            var signal = options.signal;
+            if (signal.aborted) {
+                reject(getAbortedReason(signal));
+            }
+            signal.addEventListener("abort", function() {
+                reject(getAbortedReason(signal));
+            });
+        }
+        timer = options.customTimers.setTimeout.call(undefined, function() {
+            if (typeof fallback === "function") {
+                try {
+                    resolve(fallback());
+                } catch (error) {
+                    reject(error);
+                }
+                return;
+            }
+            var message = typeof fallback === "string" ? fallback : "Promise timed out after ".concat(milliseconds, " milliseconds");
+            var timeoutError = _instanceof(fallback, Error) ? fallback : new TimeoutError(message);
+            if (typeof promise.cancel === "function") {
+                promise.cancel();
+            }
+            reject(timeoutError);
+        }, milliseconds);
+        _asyncToGenerator(function() {
+            var error;
+            return __generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        _state.trys.push([
+                            0,
+                            2,
+                            3,
+                            4
+                        ]);
+                        return [
+                            4,
+                            promise
+                        ];
+                    case 1:
+                        resolve.apply(void 0, [
+                            _state.sent()
+                        ]);
+                        return [
+                            3,
+                            4
+                        ];
+                    case 2:
+                        error = _state.sent();
+                        reject(error);
+                        return [
+                            3,
+                            4
+                        ];
+                    case 3:
+                        options.customTimers.clearTimeout.call(undefined, timer);
+                        return [
+                            7
+                        ];
+                    case 4:
+                        return [
+                            2
+                        ];
+                }
+            });
+        })();
+    });
+    cancelablePromise.clear = function() {
+        clearTimeout(timer);
+        timer = undefined;
+    };
+    return cancelablePromise;
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@common.js/p-timeout",
+  "version": "5.1.0",
+  "description": "Timeout a promise after a specified amount of time",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "devDependencies": {
+    "ava": "^3.15.0",
+    "delay": "^5.0.0",
+    "in-range": "^3.0.0",
+    "p-cancelable": "^2.1.0",
+    "time-span": "^4.0.0",
+    "tsd": "^0.14.0",
+    "xo": "^0.38.2"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "dependencies": {},
+  "main": "./index.js"
+}

package/readme.md

@@ -0,0 +1,140 @@
+# p-timeout
+
+> Timeout a promise after a specified amount of time
+
+## Install
+
+```
+$ npm install p-timeout
+```
+
+## Usage
+
+```js
+import {setTimeout} from 'timers/promises';
+import pTimeout from 'p-timeout';
+
+const delayedPromise = setTimeout(200);
+
+await pTimeout(delayedPromise, 50);
+//=> [TimeoutError: Promise timed out after 50 milliseconds]
+```
+
+## API
+
+### pTimeout(input, milliseconds, message?, options?)
+### pTimeout(input, milliseconds, fallback?, options?)
+
+Returns a decorated `input` that times out after `milliseconds` time. It has a `.clear()` method that clears the timeout.
+
+If you pass in a cancelable promise, specifically a promise with a `.cancel()` method, that method will be called when the `pTimeout` promise times out.
+
+#### input
+
+Type: `Promise`
+
+Promise to decorate.
+
+#### milliseconds
+
+Type: `number`
+
+Milliseconds before timing out.
+
+Passing `Infinity` will cause it to never time out.
+
+#### message
+
+Type: `string | Error`\
+Default: `'Promise timed out after 50 milliseconds'`
+
+Specify a custom error message or error.
+
+If you do a custom error, it's recommended to sub-class `pTimeout.TimeoutError`.
+
+#### fallback
+
+Type: `Function`
+
+Do something other than rejecting with an error on timeout.
+
+You could for example retry:
+
+```js
+import {setTimeout} from 'timers/promises';
+import pTimeout from 'p-timeout';
+
+const delayedPromise = () => setTimeout(200);
+
+await pTimeout(delayedPromise(), 50, () => {
+	return pTimeout(delayedPromise(), 300);
+});
+```
+
+#### options
+
+Type: `object`
+
+##### customTimers
+
+Type: `object` with function properties `setTimeout` and `clearTimeout`
+
+Custom implementations for the `setTimeout` and `clearTimeout` functions.
+
+Useful for testing purposes, in particular to work around [`sinon.useFakeTimers()`](https://sinonjs.org/releases/latest/fake-timers/).
+
+Example:
+
+```js
+import {setTimeout} from 'timers/promises';
+import pTimeout from 'p-timeout';
+
+const originalSetTimeout = setTimeout;
+const originalClearTimeout = clearTimeout;
+
+sinon.useFakeTimers();
+
+// Use `pTimeout` without being affected by `sinon.useFakeTimers()`:
+await pTimeout(doSomething(), 2000, undefined, {
+	customTimers: {
+		setTimeout: originalSetTimeout,
+		clearTimeout: originalClearTimeout
+	}
+});
+```
+
+#### signal
+
+Type: [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
+
+You can abort the promise using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+
+*Requires Node.js 16 or later.*
+
+```js
+import pTimeout from 'p-timeout';
+import delay from 'delay';
+
+const delayedPromise = delay(3000);
+
+const abortController = new AbortController();
+
+setTimeout(() => {
+	abortController.abort();
+}, 100);
+
+await pTimeout(delayedPromise, 2000, undefined, {
+	signal: abortController.signal
+});
+```
+
+### TimeoutError
+
+Exposed for instance checking and sub-classing.
+
+## Related
+
+- [delay](https://github.com/sindresorhus/delay) - Delay a promise a specified amount of time
+- [p-min-delay](https://github.com/sindresorhus/p-min-delay) - Delay a promise a minimum amount of time
+- [p-retry](https://github.com/sindresorhus/p-retry) - Retry a promise-returning function
+- [More…](https://github.com/sindresorhus/promise-fun)