@naturalcycles/js-lib 14.68.0 → 14.69.0

package/dist/index.d.ts

@@ -56,5 +56,6 @@ import { _gb, _hb, _kb, _mb } from './unit/size.util';
 import { is } from './vendor/is';
 import { CommonLogLevel, CommonLogFunction, CommonLogger, commonLoggerMinLevel, commonLoggerNoop, commonLogLevelNumber, commonLoggerPipe, commonLoggerPrefix } from './log/commonLogger';
 import { _safeJsonStringify } from './string/safeJsonStringify';
-export type { MemoCache, PromiseDecoratorCfg, PromiseDecoratorResp, ErrorData, ErrorObject, HttpErrorData, HttpErrorResponse, Admin401ErrorData, Admin403ErrorData, StringMap, PromiseMap, AnyObject, AnyFunction, ValuesOf, ValueOf, KeyValueTuple, ObjectMapper, ObjectPredicate, InstanceId, IsoDate, IsoDateTime, Reviver, PMapOptions, Mapper, AsyncMapper, Predicate, AsyncPredicate, BatchResult, DeferredPromise, PRetryOptions, PTimeoutOptions, TryCatchOptions, StringifyAnyOptions, JsonStringifyFunction, Merge, ReadonlyDeep, Promisable, PromiseValue, Simplify, ConditionalPick, ConditionalExcept, Class, UnixTimestamp, BaseDBEntity, SavedDBEntity, Saved, Unsaved, CreatedUpdated, CreatedUpdatedId, ObjectWithId, AnyObjectWithId, JsonSchema, JsonSchemaAny, JsonSchemaOneOf, JsonSchemaAllOf, JsonSchemaAnyOf, JsonSchemaNot, JsonSchemaRef, JsonSchemaConst, JsonSchemaEnum, JsonSchemaString, JsonSchemaNumber, JsonSchemaBoolean, JsonSchemaNull, JsonSchemaRootObject, JsonSchemaObject, JsonSchemaArray, JsonSchemaTuple, JsonSchemaBuilder, CommonLogLevel, CommonLogFunction, CommonLogger, };
-export { is, _Memo, _memoFn, _LogMethod, _getArgsSignature, _createPromiseDecorator, AppError, HttpError, AssertionError, _isErrorObject, _isHttpErrorObject, _isHttpErrorResponse, _assert, _assertEquals, _assertDeepEquals, _assertIsError, _assertIsString, _assertIsNumber, _assertTypeOf, _randomInt, _randomArrayItem, _createDeterministicRandom, _inRange, _stringMapValues, _stringMapEntries, _objectKeys, _capitalize, _upperFirst, _lowerFirst, _split, _removeWhitespace, _substringBefore, _substringBeforeLast, _substringAfter, _substringAfterLast, _substringBetweenLast, _replaceAll, _nl2br, _truncate, _truncateMiddle, _pick, _omit, _filterFalsyValues, _filterUndefinedValues, _filterNullishValues, _filterEmptyArrays, _filterEmptyValues, _filterObject, _undefinedIfEmpty, _isObject, _isPrimitive, _mapKeys, _mapValues, _mapObject, _objectNullValuesToUndefined, _deepEquals, _deepCopy, _isEmptyObject, _isEmpty, _merge, _deepTrim, _sortObjectDeep, _sortObject, _get, _set, _has, _unset, _mask, _invert, _invertMap, _by, _groupBy, _sortBy, _sortNumbers, _toFixed, _toPrecision, _round, _findLast, _takeWhile, _takeRightWhile, _dropWhile, _dropRightWhile, _countBy, _intersection, _difference, _shuffle, _mapToObject, _findKeyByValue, _anyToError, _anyToErrorObject, _errorToErrorObject, _errorObjectToAppError, _range, _uniq, _uniqBy, _flatten, _flattenDeep, _chunk, SimpleMovingAverage, _average, _averageWeighted, _percentile, _median, _debounce, _throttle, _Debounce, _Throttle, pMap, _passthroughMapper, _passUndefinedMapper, _passthroughPredicate, _passNothingPredicate, _noop, pBatch, ErrorMode, pFilter, pProps, pDelay, pDefer, pHang, pState, AggregatedError, pRetry, pTimeout, pTuple, _Retry, _Timeout, _tryCatch, _TryCatch, _try, pTry, _jsonParseIfPossible, _stringifyAny, _ms, _since, _hb, _gb, _mb, _kb, _snakeCase, _camelCase, _kebabCase, _sum, _sumBy, _clamp, _last, mergeJsonSchemaObjects, jsonSchema, JsonSchemaAnyBuilder, JSON_SCHEMA_ORDER, generateJsonSchemaFromData, _parseQueryString, _defineLazyProperty, _defineLazyProps, _lazyValue, commonLoggerMinLevel, commonLoggerNoop, commonLogLevelNumber, commonLoggerPipe, commonLoggerPrefix, _safeJsonStringify, };
+import { PQueue, PQueueCfg } from './promise/pQueue';
+export type { PQueueCfg, MemoCache, PromiseDecoratorCfg, PromiseDecoratorResp, ErrorData, ErrorObject, HttpErrorData, HttpErrorResponse, Admin401ErrorData, Admin403ErrorData, StringMap, PromiseMap, AnyObject, AnyFunction, ValuesOf, ValueOf, KeyValueTuple, ObjectMapper, ObjectPredicate, InstanceId, IsoDate, IsoDateTime, Reviver, PMapOptions, Mapper, AsyncMapper, Predicate, AsyncPredicate, BatchResult, DeferredPromise, PRetryOptions, PTimeoutOptions, TryCatchOptions, StringifyAnyOptions, JsonStringifyFunction, Merge, ReadonlyDeep, Promisable, PromiseValue, Simplify, ConditionalPick, ConditionalExcept, Class, UnixTimestamp, BaseDBEntity, SavedDBEntity, Saved, Unsaved, CreatedUpdated, CreatedUpdatedId, ObjectWithId, AnyObjectWithId, JsonSchema, JsonSchemaAny, JsonSchemaOneOf, JsonSchemaAllOf, JsonSchemaAnyOf, JsonSchemaNot, JsonSchemaRef, JsonSchemaConst, JsonSchemaEnum, JsonSchemaString, JsonSchemaNumber, JsonSchemaBoolean, JsonSchemaNull, JsonSchemaRootObject, JsonSchemaObject, JsonSchemaArray, JsonSchemaTuple, JsonSchemaBuilder, CommonLogLevel, CommonLogFunction, CommonLogger, };
+export { is, _Memo, _memoFn, _LogMethod, _getArgsSignature, _createPromiseDecorator, AppError, HttpError, AssertionError, _isErrorObject, _isHttpErrorObject, _isHttpErrorResponse, _assert, _assertEquals, _assertDeepEquals, _assertIsError, _assertIsString, _assertIsNumber, _assertTypeOf, _randomInt, _randomArrayItem, _createDeterministicRandom, _inRange, _stringMapValues, _stringMapEntries, _objectKeys, _capitalize, _upperFirst, _lowerFirst, _split, _removeWhitespace, _substringBefore, _substringBeforeLast, _substringAfter, _substringAfterLast, _substringBetweenLast, _replaceAll, _nl2br, _truncate, _truncateMiddle, _pick, _omit, _filterFalsyValues, _filterUndefinedValues, _filterNullishValues, _filterEmptyArrays, _filterEmptyValues, _filterObject, _undefinedIfEmpty, _isObject, _isPrimitive, _mapKeys, _mapValues, _mapObject, _objectNullValuesToUndefined, _deepEquals, _deepCopy, _isEmptyObject, _isEmpty, _merge, _deepTrim, _sortObjectDeep, _sortObject, _get, _set, _has, _unset, _mask, _invert, _invertMap, _by, _groupBy, _sortBy, _sortNumbers, _toFixed, _toPrecision, _round, _findLast, _takeWhile, _takeRightWhile, _dropWhile, _dropRightWhile, _countBy, _intersection, _difference, _shuffle, _mapToObject, _findKeyByValue, _anyToError, _anyToErrorObject, _errorToErrorObject, _errorObjectToAppError, _range, _uniq, _uniqBy, _flatten, _flattenDeep, _chunk, SimpleMovingAverage, _average, _averageWeighted, _percentile, _median, _debounce, _throttle, _Debounce, _Throttle, pMap, _passthroughMapper, _passUndefinedMapper, _passthroughPredicate, _passNothingPredicate, _noop, pBatch, ErrorMode, pFilter, pProps, pDelay, pDefer, pHang, pState, AggregatedError, pRetry, pTimeout, pTuple, _Retry, _Timeout, _tryCatch, _TryCatch, _try, pTry, _jsonParseIfPossible, _stringifyAny, _ms, _since, _hb, _gb, _mb, _kb, _snakeCase, _camelCase, _kebabCase, _sum, _sumBy, _clamp, _last, mergeJsonSchemaObjects, jsonSchema, JsonSchemaAnyBuilder, JSON_SCHEMA_ORDER, generateJsonSchemaFromData, _parseQueryString, _defineLazyProperty, _defineLazyProps, _lazyValue, commonLoggerMinLevel, commonLoggerNoop, commonLogLevelNumber, commonLoggerPipe, commonLoggerPrefix, _safeJsonStringify, PQueue, };

package/dist/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports._isObject = exports._undefinedIfEmpty = exports._filterObject = exports._filterEmptyValues = exports._filterEmptyArrays = exports._filterNullishValues = exports._filterUndefinedValues = exports._filterFalsyValues = exports._omit = exports._pick = exports._truncateMiddle = exports._truncate = exports._nl2br = exports._replaceAll = exports._substringBetweenLast = exports._substringAfterLast = exports._substringAfter = exports._substringBeforeLast = exports._substringBefore = exports._removeWhitespace = exports._split = exports._lowerFirst = exports._upperFirst = exports._capitalize = exports._objectKeys = exports._stringMapEntries = exports._stringMapValues = exports._inRange = exports._createDeterministicRandom = exports._randomArrayItem = exports._randomInt = exports._assertTypeOf = exports._assertIsNumber = exports._assertIsString = exports._assertIsError = exports._assertDeepEquals = exports._assertEquals = exports._assert = exports._isHttpErrorResponse = exports._isHttpErrorObject = exports._isErrorObject = exports.AssertionError = exports.HttpError = exports.AppError = exports._createPromiseDecorator = exports._getArgsSignature = exports._LogMethod = exports._memoFn = exports._Memo = exports.is = void 0;
 exports._average = exports.SimpleMovingAverage = exports._chunk = exports._flattenDeep = exports._flatten = exports._uniqBy = exports._uniq = exports._range = exports._errorObjectToAppError = exports._errorToErrorObject = exports._anyToErrorObject = exports._anyToError = exports._findKeyByValue = exports._mapToObject = exports._shuffle = exports._difference = exports._intersection = exports._countBy = exports._dropRightWhile = exports._dropWhile = exports._takeRightWhile = exports._takeWhile = exports._findLast = exports._round = exports._toPrecision = exports._toFixed = exports._sortNumbers = exports._sortBy = exports._groupBy = exports._by = exports._invertMap = exports._invert = exports._mask = exports._unset = exports._has = exports._set = exports._get = exports._sortObject = exports._sortObjectDeep = exports._deepTrim = exports._merge = exports._isEmpty = exports._isEmptyObject = exports._deepCopy = exports._deepEquals = exports._objectNullValuesToUndefined = exports._mapObject = exports._mapValues = exports._mapKeys = exports._isPrimitive = void 0;
 exports.JSON_SCHEMA_ORDER = exports.JsonSchemaAnyBuilder = exports.jsonSchema = exports.mergeJsonSchemaObjects = exports._last = exports._clamp = exports._sumBy = exports._sum = exports._kebabCase = exports._camelCase = exports._snakeCase = exports._kb = exports._mb = exports._gb = exports._hb = exports._since = exports._ms = exports._stringifyAny = exports._jsonParseIfPossible = exports.pTry = exports._try = exports._TryCatch = exports._tryCatch = exports._Timeout = exports._Retry = exports.pTuple = exports.pTimeout = exports.pRetry = exports.AggregatedError = exports.pState = exports.pHang = exports.pDefer = exports.pDelay = exports.pProps = exports.pFilter = exports.ErrorMode = exports.pBatch = exports._noop = exports._passNothingPredicate = exports._passthroughPredicate = exports._passUndefinedMapper = exports._passthroughMapper = exports.pMap = exports._Throttle = exports._Debounce = exports._throttle = exports._debounce = exports._median = exports._percentile = exports._averageWeighted = void 0;
-exports._safeJsonStringify = exports.commonLoggerPrefix = exports.commonLoggerPipe = exports.commonLogLevelNumber = exports.commonLoggerNoop = exports.commonLoggerMinLevel = exports._lazyValue = exports._defineLazyProps = exports._defineLazyProperty = exports._parseQueryString = exports.generateJsonSchemaFromData = void 0;
+exports.PQueue = exports._safeJsonStringify = exports.commonLoggerPrefix = exports.commonLoggerPipe = exports.commonLogLevelNumber = exports.commonLoggerNoop = exports.commonLoggerMinLevel = exports._lazyValue = exports._defineLazyProps = exports._defineLazyProperty = exports._parseQueryString = exports.generateJsonSchemaFromData = void 0;
 const array_util_1 = require("./array/array.util");
 Object.defineProperty(exports, "_by", { enumerable: true, get: function () { return array_util_1._by; } });
 Object.defineProperty(exports, "_chunk", { enumerable: true, get: function () { return array_util_1._chunk; } });
@@ -219,3 +219,5 @@ Object.defineProperty(exports, "commonLoggerPipe", { enumerable: true, get: func
 Object.defineProperty(exports, "commonLoggerPrefix", { enumerable: true, get: function () { return commonLogger_1.commonLoggerPrefix; } });
 const safeJsonStringify_1 = require("./string/safeJsonStringify");
 Object.defineProperty(exports, "_safeJsonStringify", { enumerable: true, get: function () { return safeJsonStringify_1._safeJsonStringify; } });
+const pQueue_1 = require("./promise/pQueue");
+Object.defineProperty(exports, "PQueue", { enumerable: true, get: function () { return pQueue_1.PQueue; } });

package/dist/promise/pQueue.d.ts

@@ -0,0 +1,43 @@
+import { CommonLogger } from '../log/commonLogger';
+export interface PQueueCfg {
+    concurrency: number;
+    /**
+     * Default: THROW_IMMEDIATELY
+     */
+    /**
+     * @default true
+     */
+    /**
+     * Default to `console`
+     */
+    logger?: CommonLogger;
+    /**
+     * If true - will LOG EVERYTHING:)
+     */
+    debug?: boolean;
+}
+export declare type PromiseReturningFunction = () => Promise<any>;
+/**
+ * Inspired by: https://github.com/sindresorhus/p-queue
+ *
+ * Allows to push "jobs" to the queue and control its concurrency.
+ * Jobs are "promise-returning functions".
+ *
+ * API is @experimental
+ */
+export declare class PQueue {
+    constructor(cfg: PQueueCfg);
+    private readonly cfg;
+    private debug;
+    inFlight: number;
+    private queue;
+    private onIdleListeners;
+    get queueSize(): number;
+    /**
+     * Returns a Promise that resolves when the queue is Idle (next time, since the call).
+     * Resolves immediately in case the queue is Idle.
+     * Idle means 0 queue and 0 inFlight.
+     */
+    onIdle(): Promise<void>;
+    push(fn: PromiseReturningFunction): void;
+}

package/dist/promise/pQueue.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PQueue = void 0;
+const pDefer_1 = require("./pDefer");
+/**
+ * Inspired by: https://github.com/sindresorhus/p-queue
+ *
+ * Allows to push "jobs" to the queue and control its concurrency.
+ * Jobs are "promise-returning functions".
+ *
+ * API is @experimental
+ */
+class PQueue {
+    constructor(cfg) {
+        this.inFlight = 0;
+        this.queue = [];
+        this.onIdleListeners = [];
+        this.cfg = {
+            // concurrency: Number.MAX_SAFE_INTEGER,
+            logger: console,
+            debug: false,
+            ...cfg,
+        };
+        if (!cfg.debug) {
+            this.debug = () => { };
+        }
+    }
+    debug(...args) {
+        this.cfg.logger.log(...args);
+    }
+    get queueSize() {
+        return this.queue.length;
+    }
+    /**
+     * Returns a Promise that resolves when the queue is Idle (next time, since the call).
+     * Resolves immediately in case the queue is Idle.
+     * Idle means 0 queue and 0 inFlight.
+     */
+    onIdle() {
+        if (this.queue.length === 0)
+            return Promise.resolve();
+        const listener = (0, pDefer_1.pDefer)();
+        this.onIdleListeners.push(listener);
+        return listener;
+    }
+    push(fn) {
+        const { concurrency } = this.cfg;
+        if (this.inFlight < concurrency) {
+            // There is room for more jobs. Can start immediately
+            this.inFlight++;
+            this.debug(`inFlight++ ${this.inFlight}/${concurrency}, queue ${this.queue.length}`);
+            fn()
+                .catch(err => {
+                this.cfg.logger.error(err);
+            })
+                .finally(() => {
+                this.inFlight--;
+                this.debug(`inFlight-- ${this.inFlight}/${concurrency}, queue ${this.queue.length}`);
+                // check if there's room to start next job
+                if (this.queue.length && this.inFlight <= concurrency) {
+                    const nextFn = this.queue.shift();
+                    this.push(nextFn);
+                }
+                else {
+                    if (this.inFlight === 0) {
+                        this.debug('onIdle');
+                        this.onIdleListeners.forEach(defer => defer.resolve());
+                        this.onIdleListeners.length = 0; // empty the array
+                    }
+                }
+            });
+        }
+        else {
+            this.queue.push(fn);
+            this.debug(`inFlight ${this.inFlight}/${concurrency}, queue++ ${this.queue.length}`);
+        }
+    }
+}
+exports.PQueue = PQueue;

package/dist/promise/pTimeout.d.ts

@@ -1,3 +1,4 @@
+import { AnyFunction } from '../types';
 export interface PTimeoutOptions {
     /**
      * Timeout in milliseconds.
@@ -19,4 +20,4 @@ export interface PTimeoutOptions {
  * Throws an Error if the Function is not resolved in a certain time.
  * If the Function rejects - passes this rejection further.
  */
-export declare function pTimeout<T extends Function>(fn: T, opt: PTimeoutOptions): T;
+export declare function pTimeout<T extends AnyFunction>(fn: T, opt: PTimeoutOptions): T;

package/dist/promise/pTimeout.js

@@ -6,7 +6,6 @@ exports.pTimeout = void 0;
  * Throws an Error if the Function is not resolved in a certain time.
  * If the Function rejects - passes this rejection further.
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
 function pTimeout(fn, opt) {
     // const fname = fn.name || 'function'
     const { timeout, name, onTimeout } = opt;

package/dist-esm/index.js

@@ -52,4 +52,5 @@ import { _gb, _hb, _kb, _mb } from './unit/size.util';
 import { is } from './vendor/is';
 import { commonLoggerMinLevel, commonLoggerNoop, commonLogLevelNumber, commonLoggerPipe, commonLoggerPrefix, } from './log/commonLogger';
 import { _safeJsonStringify } from './string/safeJsonStringify';
-export { is, _Memo, _memoFn, _LogMethod, _getArgsSignature, _createPromiseDecorator, AppError, HttpError, AssertionError, _isErrorObject, _isHttpErrorObject, _isHttpErrorResponse, _assert, _assertEquals, _assertDeepEquals, _assertIsError, _assertIsString, _assertIsNumber, _assertTypeOf, _randomInt, _randomArrayItem, _createDeterministicRandom, _inRange, _stringMapValues, _stringMapEntries, _objectKeys, _capitalize, _upperFirst, _lowerFirst, _split, _removeWhitespace, _substringBefore, _substringBeforeLast, _substringAfter, _substringAfterLast, _substringBetweenLast, _replaceAll, _nl2br, _truncate, _truncateMiddle, _pick, _omit, _filterFalsyValues, _filterUndefinedValues, _filterNullishValues, _filterEmptyArrays, _filterEmptyValues, _filterObject, _undefinedIfEmpty, _isObject, _isPrimitive, _mapKeys, _mapValues, _mapObject, _objectNullValuesToUndefined, _deepEquals, _deepCopy, _isEmptyObject, _isEmpty, _merge, _deepTrim, _sortObjectDeep, _sortObject, _get, _set, _has, _unset, _mask, _invert, _invertMap, _by, _groupBy, _sortBy, _sortNumbers, _toFixed, _toPrecision, _round, _findLast, _takeWhile, _takeRightWhile, _dropWhile, _dropRightWhile, _countBy, _intersection, _difference, _shuffle, _mapToObject, _findKeyByValue, _anyToError, _anyToErrorObject, _errorToErrorObject, _errorObjectToAppError, _range, _uniq, _uniqBy, _flatten, _flattenDeep, _chunk, SimpleMovingAverage, _average, _averageWeighted, _percentile, _median, _debounce, _throttle, _Debounce, _Throttle, pMap, _passthroughMapper, _passUndefinedMapper, _passthroughPredicate, _passNothingPredicate, _noop, pBatch, ErrorMode, pFilter, pProps, pDelay, pDefer, pHang, pState, AggregatedError, pRetry, pTimeout, pTuple, _Retry, _Timeout, _tryCatch, _TryCatch, _try, pTry, _jsonParseIfPossible, _stringifyAny, _ms, _since, _hb, _gb, _mb, _kb, _snakeCase, _camelCase, _kebabCase, _sum, _sumBy, _clamp, _last, mergeJsonSchemaObjects, jsonSchema, JsonSchemaAnyBuilder, JSON_SCHEMA_ORDER, generateJsonSchemaFromData, _parseQueryString, _defineLazyProperty, _defineLazyProps, _lazyValue, commonLoggerMinLevel, commonLoggerNoop, commonLogLevelNumber, commonLoggerPipe, commonLoggerPrefix, _safeJsonStringify, };
+import { PQueue } from './promise/pQueue';
+export { is, _Memo, _memoFn, _LogMethod, _getArgsSignature, _createPromiseDecorator, AppError, HttpError, AssertionError, _isErrorObject, _isHttpErrorObject, _isHttpErrorResponse, _assert, _assertEquals, _assertDeepEquals, _assertIsError, _assertIsString, _assertIsNumber, _assertTypeOf, _randomInt, _randomArrayItem, _createDeterministicRandom, _inRange, _stringMapValues, _stringMapEntries, _objectKeys, _capitalize, _upperFirst, _lowerFirst, _split, _removeWhitespace, _substringBefore, _substringBeforeLast, _substringAfter, _substringAfterLast, _substringBetweenLast, _replaceAll, _nl2br, _truncate, _truncateMiddle, _pick, _omit, _filterFalsyValues, _filterUndefinedValues, _filterNullishValues, _filterEmptyArrays, _filterEmptyValues, _filterObject, _undefinedIfEmpty, _isObject, _isPrimitive, _mapKeys, _mapValues, _mapObject, _objectNullValuesToUndefined, _deepEquals, _deepCopy, _isEmptyObject, _isEmpty, _merge, _deepTrim, _sortObjectDeep, _sortObject, _get, _set, _has, _unset, _mask, _invert, _invertMap, _by, _groupBy, _sortBy, _sortNumbers, _toFixed, _toPrecision, _round, _findLast, _takeWhile, _takeRightWhile, _dropWhile, _dropRightWhile, _countBy, _intersection, _difference, _shuffle, _mapToObject, _findKeyByValue, _anyToError, _anyToErrorObject, _errorToErrorObject, _errorObjectToAppError, _range, _uniq, _uniqBy, _flatten, _flattenDeep, _chunk, SimpleMovingAverage, _average, _averageWeighted, _percentile, _median, _debounce, _throttle, _Debounce, _Throttle, pMap, _passthroughMapper, _passUndefinedMapper, _passthroughPredicate, _passNothingPredicate, _noop, pBatch, ErrorMode, pFilter, pProps, pDelay, pDefer, pHang, pState, AggregatedError, pRetry, pTimeout, pTuple, _Retry, _Timeout, _tryCatch, _TryCatch, _try, pTry, _jsonParseIfPossible, _stringifyAny, _ms, _since, _hb, _gb, _mb, _kb, _snakeCase, _camelCase, _kebabCase, _sum, _sumBy, _clamp, _last, mergeJsonSchemaObjects, jsonSchema, JsonSchemaAnyBuilder, JSON_SCHEMA_ORDER, generateJsonSchemaFromData, _parseQueryString, _defineLazyProperty, _defineLazyProps, _lazyValue, commonLoggerMinLevel, commonLoggerNoop, commonLogLevelNumber, commonLoggerPipe, commonLoggerPrefix, _safeJsonStringify, PQueue, };

package/dist-esm/promise/pQueue.js

@@ -0,0 +1,72 @@
+import { pDefer } from './pDefer';
+/**
+ * Inspired by: https://github.com/sindresorhus/p-queue
+ *
+ * Allows to push "jobs" to the queue and control its concurrency.
+ * Jobs are "promise-returning functions".
+ *
+ * API is @experimental
+ */
+export class PQueue {
+    constructor(cfg) {
+        this.inFlight = 0;
+        this.queue = [];
+        this.onIdleListeners = [];
+        this.cfg = Object.assign({ 
+            // concurrency: Number.MAX_SAFE_INTEGER,
+            logger: console, debug: false }, cfg);
+        if (!cfg.debug) {
+            this.debug = () => { };
+        }
+    }
+    debug(...args) {
+        this.cfg.logger.log(...args);
+    }
+    get queueSize() {
+        return this.queue.length;
+    }
+    /**
+     * Returns a Promise that resolves when the queue is Idle (next time, since the call).
+     * Resolves immediately in case the queue is Idle.
+     * Idle means 0 queue and 0 inFlight.
+     */
+    onIdle() {
+        if (this.queue.length === 0)
+            return Promise.resolve();
+        const listener = pDefer();
+        this.onIdleListeners.push(listener);
+        return listener;
+    }
+    push(fn) {
+        const { concurrency } = this.cfg;
+        if (this.inFlight < concurrency) {
+            // There is room for more jobs. Can start immediately
+            this.inFlight++;
+            this.debug(`inFlight++ ${this.inFlight}/${concurrency}, queue ${this.queue.length}`);
+            fn()
+                .catch(err => {
+                this.cfg.logger.error(err);
+            })
+                .finally(() => {
+                this.inFlight--;
+                this.debug(`inFlight-- ${this.inFlight}/${concurrency}, queue ${this.queue.length}`);
+                // check if there's room to start next job
+                if (this.queue.length && this.inFlight <= concurrency) {
+                    const nextFn = this.queue.shift();
+                    this.push(nextFn);
+                }
+                else {
+                    if (this.inFlight === 0) {
+                        this.debug('onIdle');
+                        this.onIdleListeners.forEach(defer => defer.resolve());
+                        this.onIdleListeners.length = 0; // empty the array
+                    }
+                }
+            });
+        }
+        else {
+            this.queue.push(fn);
+            this.debug(`inFlight ${this.inFlight}/${concurrency}, queue++ ${this.queue.length}`);
+        }
+    }
+}

package/dist-esm/promise/pTimeout.js

@@ -3,7 +3,6 @@
  * Throws an Error if the Function is not resolved in a certain time.
  * If the Function rejects - passes this rejection further.
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
 export function pTimeout(fn, opt) {
     // const fname = fn.name || 'function'
     const { timeout, name, onTimeout } = opt;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.68.0",
+  "version": "14.69.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/index.ts

@@ -235,8 +235,10 @@ import {
   commonLoggerPrefix,
 } from './log/commonLogger'
 import { _safeJsonStringify } from './string/safeJsonStringify'
+import { PQueue, PQueueCfg } from './promise/pQueue'
 
 export type {
+  PQueueCfg,
   MemoCache,
   PromiseDecoratorCfg,
   PromiseDecoratorResp,
@@ -473,4 +475,5 @@ export {
   commonLoggerPipe,
   commonLoggerPrefix,
   _safeJsonStringify,
+  PQueue,
 }

package/src/promise/pQueue.ts

@@ -0,0 +1,117 @@
+import { CommonLogger } from '../log/commonLogger'
+import { DeferredPromise, pDefer } from './pDefer'
+
+export interface PQueueCfg {
+  concurrency: number
+
+  /**
+   * Default: THROW_IMMEDIATELY
+   */
+  // errorMode?: ErrorMode
+
+  /**
+   * @default true
+   */
+  // autoStart?: boolean
+
+  /**
+   * Default to `console`
+   */
+  logger?: CommonLogger
+
+  /**
+   * If true - will LOG EVERYTHING:)
+   */
+  debug?: boolean
+
+  // logStatusChange?: boolean
+  // logSizeChange?: boolean
+
+  // timeout
+}
+
+export type PromiseReturningFunction = () => Promise<any>
+
+/**
+ * Inspired by: https://github.com/sindresorhus/p-queue
+ *
+ * Allows to push "jobs" to the queue and control its concurrency.
+ * Jobs are "promise-returning functions".
+ *
+ * API is @experimental
+ */
+export class PQueue {
+  constructor(cfg: PQueueCfg) {
+    this.cfg = {
+      // concurrency: Number.MAX_SAFE_INTEGER,
+      logger: console,
+      debug: false,
+      ...cfg,
+    }
+
+    if (!cfg.debug) {
+      this.debug = () => {}
+    }
+  }
+
+  private readonly cfg: Required<PQueueCfg>
+
+  private debug(...args: any[]): void {
+    this.cfg.logger.log(...args)
+  }
+
+  inFlight = 0
+  private queue: PromiseReturningFunction[] = []
+  private onIdleListeners: DeferredPromise[] = []
+
+  get queueSize(): number {
+    return this.queue.length
+  }
+
+  /**
+   * Returns a Promise that resolves when the queue is Idle (next time, since the call).
+   * Resolves immediately in case the queue is Idle.
+   * Idle means 0 queue and 0 inFlight.
+   */
+  onIdle(): Promise<void> {
+    if (this.queue.length === 0) return Promise.resolve()
+
+    const listener = pDefer()
+    this.onIdleListeners.push(listener)
+    return listener
+  }
+
+  push(fn: PromiseReturningFunction): void {
+    const { concurrency } = this.cfg
+
+    if (this.inFlight < concurrency) {
+      // There is room for more jobs. Can start immediately
+      this.inFlight++
+      this.debug(`inFlight++ ${this.inFlight}/${concurrency}, queue ${this.queue.length}`)
+
+      fn()
+        .catch(err => {
+          this.cfg.logger.error(err)
+        })
+        .finally(() => {
+          this.inFlight--
+          this.debug(`inFlight-- ${this.inFlight}/${concurrency}, queue ${this.queue.length}`)
+
+          // check if there's room to start next job
+          if (this.queue.length && this.inFlight <= concurrency) {
+            const nextFn = this.queue.shift()!
+            this.push(nextFn)
+          } else {
+            if (this.inFlight === 0) {
+              this.debug('onIdle')
+              this.onIdleListeners.forEach(defer => defer.resolve())
+              this.onIdleListeners.length = 0 // empty the array
+            }
+          }
+        })
+    } else {
+      this.queue.push(fn)
+      this.debug(`inFlight ${this.inFlight}/${concurrency}, queue++ ${this.queue.length}`)
+    }
+  }
+}

package/src/promise/pTimeout.ts

@@ -1,3 +1,5 @@
+import { AnyFunction } from '../types'
+
 export interface PTimeoutOptions {
   /**
    * Timeout in milliseconds.
@@ -22,8 +24,7 @@ export interface PTimeoutOptions {
  * Throws an Error if the Function is not resolved in a certain time.
  * If the Function rejects - passes this rejection further.
  */
-// eslint-disable-next-line @typescript-eslint/ban-types
-export function pTimeout<T extends Function>(fn: T, opt: PTimeoutOptions): T {
+export function pTimeout<T extends AnyFunction>(fn: T, opt: PTimeoutOptions): T {
   // const fname = fn.name || 'function'
   const { timeout, name, onTimeout } = opt