@orioro/util 0.5.0 → 0.6.0

package/dist/index.mjs

@@ -483,6 +483,38 @@ function arrayChunk(array, chunkSize) {
   return chunks;
 }
 
+var TimeoutError = /** @class */function (_super) {
+  __extends(TimeoutError, _super);
+  function TimeoutError(message) {
+    var _this = _super.call(this, message) || this;
+    _this.name = 'TimeoutError';
+    _this.code = 'ETIMEDOUT';
+    _this.timestamp = new Date();
+    // Maintain proper stack trace (only available in V8 engines, e.g., Chrome and Node.js)
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(_this, TimeoutError);
+    }
+    return _this;
+  }
+  return TimeoutError;
+}(Error);
+function withTimeout(fn, timeout) {
+  return function () {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+      args[_i] = arguments[_i];
+    }
+    return new Promise(function (resolve, reject) {
+      var timer = setTimeout(function () {
+        reject(new TimeoutError("Function timed out (max: ".concat(timeout, "ms)")));
+      }, timeout);
+      fn.apply(void 0, args).then(resolve)["catch"](reject)["finally"](function () {
+        return clearTimeout(timer);
+      });
+    });
+  };
+}
+
 var SKIPPED = Symbol();
 function batchFn(itemFn, _a) {
   var _b = _a === void 0 ? {} : _a,
@@ -490,7 +522,12 @@ function batchFn(itemFn, _a) {
     batchSize = _c === void 0 ? 10 : _c,
     skip = _b.skip,
     _d = _b.retry,
-    retry = _d === void 0 ? false : _d;
+    retry = _d === void 0 ? false : _d,
+    timeout = _b.timeout;
+  //
+  // Optionally wrap itemFn into timeout
+  //
+  itemFn = timeout ? withTimeout(itemFn, timeout) : itemFn;
   return function batchExec(items) {
     var _this = this;
     var batches = arrayChunk(items, batchSize);
@@ -1485,4 +1522,4 @@ validateAsync.or = or;
 validateAsync.not = not;
 validateAsync.assertValid = assertValidAsync;
 
-export { PromiseLikeEventEmitter, SKIPPED, ValidationError, batchFn, debugFn, deepFreeze, interpolate, makeTypeOf, maybeFn, parseBatchedResults, pickPaths, promiseReduce, resolveNestedPromises, switchExec, switchValue, typeMap, typeOf, validate, validateAsync, wait };
+export { PromiseLikeEventEmitter, SKIPPED, TimeoutError, ValidationError, batchFn, debugFn, deepFreeze, interpolate, makeTypeOf, maybeFn, parseBatchedResults, pickPaths, promiseReduce, resolveNestedPromises, switchExec, switchValue, typeMap, typeOf, validate, validateAsync, wait, withTimeout };

package/dist/promise/batchFn.d.ts

@@ -4,6 +4,7 @@ type BatchFnOptions = {
     skip?: (input: any) => Promise<boolean> | boolean;
     batchSize?: number;
     retry?: BackoffOptions | boolean;
+    timeout?: number | false;
 };
 type Batch = {
     index: number;
@@ -39,7 +40,7 @@ type EventTypes = {
     }) => void;
     error: (err: Error) => void;
 };
-export declare function batchFn(itemFn: (input: any) => Promise<any> | any, { batchSize, skip, retry }?: BatchFnOptions): (items: any[]) => PromiseLikeEventEmitter<any[], EventTypes>;
+export declare function batchFn(itemFn: (input: any) => Promise<any> | any, { batchSize, skip, retry, timeout }?: BatchFnOptions): (items: any[]) => PromiseLikeEventEmitter<any[], EventTypes>;
 type ParsedBatchResults = {
     results: any[];
     errors: Error[];

package/dist/promise/index.d.ts

@@ -1,3 +1,4 @@
 export * from './promiseReduce';
 export * from './resolveNestedPromises';
 export * from './batchFn';
+export * from './withTimeout';

package/dist/promise/withTimeout.d.ts

@@ -0,0 +1,6 @@
+export declare class TimeoutError extends Error {
+    code: string;
+    timestamp: Date;
+    constructor(message: string);
+}
+export declare function withTimeout<T extends (...args: any[]) => Promise<any>>(fn: T, timeout: number): (...args: Parameters<T>) => Promise<ReturnType<T>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orioro/util",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "packageManager": "yarn@4.0.2",
   "type": "module",
   "main": "dist/index.mjs",