@common.js/function-timeout 0.1.1

package/README.md

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

package/browser.js

@@ -0,0 +1,60 @@
+// Even though the browser version is a no-op, we wrap it to ensure consistent behavior.
+"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, {
+    default: function() {
+        return functionTimeout;
+    },
+    isTimeoutError: function() {
+        return isTimeoutError;
+    }
+});
+function _arrayLikeToArray(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _arrayWithoutHoles(arr) {
+    if (Array.isArray(arr)) return _arrayLikeToArray(arr);
+}
+function _iterableToArray(iter) {
+    if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+}
+function _nonIterableSpread() {
+    throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _toConsumableArray(arr) {
+    return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
+}
+function _unsupportedIterableToArray(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+function functionTimeout(function_) {
+    var wrappedFunction = function() {
+        for(var _len = arguments.length, arguments_ = new Array(_len), _key = 0; _key < _len; _key++){
+            arguments_[_key] = arguments[_key];
+        }
+        return function_.apply(void 0, _toConsumableArray(arguments_));
+    };
+    Object.defineProperty(wrappedFunction, "name", {
+        value: "functionTimeout(".concat(function_.name || "<anonymous>", ")"),
+        configurable: true
+    });
+    return wrappedFunction;
+}
+function isTimeoutError() {
+    return false;
+}

package/index.d.ts

@@ -0,0 +1,39 @@
+export type Options = {
+	/**
+	The time in milliseconds to wait before timing out.
+
+	Keep in mind that execution time can vary between different hardware and Node.js versions. Set a generous timeout to avoid flakiness.
+	*/
+	readonly timeout?: number;
+};
+
+/**
+Returns a wrapped version of the given function that throws a timeout error if the execution takes longer than the given timeout.
+
+@example
+```
+import functionTimeout, {isTimeoutError} from 'function-timeout';
+
+const generateNumbers = count => {
+	// Imagine this takes a long time.
+};
+
+const generateNumbersWithTimeout = functionTimeout(generateNumbers, {timeout: 100});
+
+try {
+	console.log(generateNumbersWithTimeout(500));
+} catch (error) {
+	if (isTimeoutError(error)) {
+		console.error('Timed out');
+	} else {
+		throw error;
+	}
+}
+```
+*/
+export default function functionTimeout<T extends Function>(function_: T, options: Options): T; // eslint-disable-line @typescript-eslint/ban-types
+
+/**
+Returns a boolean for whether the given error is a timeout error.
+*/
+export function isTimeoutError(error: unknown): boolean;

package/index.js

@@ -0,0 +1,75 @@
+"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, {
+    default: function() {
+        return functionTimeout;
+    },
+    isTimeoutError: function() {
+        return isTimeoutError;
+    }
+});
+var _nodeVm = /*#__PURE__*/ _interopRequireDefault(require("node:vm"));
+function _arrayLikeToArray(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _arrayWithoutHoles(arr) {
+    if (Array.isArray(arr)) return _arrayLikeToArray(arr);
+}
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _iterableToArray(iter) {
+    if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+}
+function _nonIterableSpread() {
+    throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _toConsumableArray(arr) {
+    return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
+}
+function _unsupportedIterableToArray(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+function functionTimeout(function_) {
+    var timeout = (arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {}).timeout;
+    var script = new _nodeVm.default.Script("returnValue = function_()");
+    var wrappedFunction = function() {
+        for(var _len = arguments.length, arguments_ = new Array(_len), _key = 0; _key < _len; _key++){
+            arguments_[_key] = arguments[_key];
+        }
+        var context = {
+            function_: function() {
+                return function_.apply(void 0, _toConsumableArray(arguments_));
+            }
+        };
+        script.runInNewContext(context, {
+            timeout: timeout
+        });
+        return context.returnValue;
+    };
+    Object.defineProperty(wrappedFunction, "name", {
+        value: "functionTimeout(".concat(function_.name || "<anonymous>", ")"),
+        configurable: true
+    });
+    return wrappedFunction;
+}
+function isTimeoutError(error) {
+    return (error === null || error === void 0 ? void 0 : error.code) === "ERR_SCRIPT_EXECUTION_TIMEOUT";
+}

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,32 @@
+{
+  "name": "@common.js/function-timeout",
+  "version": "0.1.1",
+  "description": "Make a synchronous function have a timeout",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=14.16"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "browser.js"
+  ],
+  "devDependencies": {
+    "ava": "^4.3.0",
+    "in-range": "^3.0.0",
+    "time-span": "^5.0.0",
+    "tsd": "^0.20.0",
+    "xo": "^0.49.0"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "dependencies": {},
+  "types": "./index.d.ts",
+  "main": "./index.js",
+  "browser": "./browser.js"
+}

package/readme.md

@@ -0,0 +1,64 @@
+# function-timeout
+
+> Make a synchronous function have a timeout
+
+This can be useful if you accept external data and want to ensure processing it does not take too long.
+
+The timeout only works in Node.js. When used in a browser, the function will be wrapped, but never time out.
+
+*I have a [different package](https://github.com/sindresorhus/super-regex) to prevent [ReDoS](https://en.wikipedia.org/wiki/ReDoS) for regexes.*
+
+## Install
+
+```sh
+npm install function-timeout
+```
+
+## Usage
+
+```js
+import functionTimeout, {isTimeoutError} from 'function-timeout';
+
+const generateNumbers = count => {
+	// Imagine this takes a long time.
+};
+
+const generateNumbersWithTimeout = functionTimeout(generateNumbers, {timeout: 100});
+
+try {
+	console.log(generateNumbersWithTimeout(500));
+} catch (error) {
+	if (isTimeoutError(error)) {
+		console.error('Timed out');
+	} else {
+		throw error;
+	}
+}
+```
+
+## API
+
+### functionTimeout(function, options?)
+
+Returns a wrapped version of the given function that throws a timeout error if the execution takes longer than the given timeout.
+
+#### options
+
+Type: `object`
+
+##### timeout?
+
+Type: `number` *(integer)*
+
+The time in milliseconds to wait before timing out.
+
+Keep in mind that execution time can vary between different hardware and Node.js versions. Set a generous timeout to avoid flakiness.
+
+### isTimeoutError(error)
+
+Returns a boolean for whether the given error is a timeout error.
+
+## Related
+
+- [super-regex](https://github.com/sindresorhus/super-regex) - Make a regular expression time out if it takes too long to execute
+- [p-timeout](https://github.com/sindresorhus/p-timeout) - Timeout a promise after a certain amount of time