@keeex/utils 7.2.1 → 7.4.0

package/lib/bits/triggers/types.js

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+export var TriggerState;
+(function (TriggerState) {
+    /** Trigger was not triggered */
+    TriggerState["inactive"] = "inactive";
+    /** Trigger was triggered, fuse timer is counting down */
+    TriggerState["pending"] = "pending";
+    /** Trigger was triggered and timer expired, the handler is running */
+    TriggerState["running"] = "running";
+    /** Handler is running, and trigger was called again */
+    TriggerState["runningRetrigger"] = "runningTrigger";
+    /** Last run after stop */
+    TriggerState["runningStop"] = "runningStop";
+    /** Handler is killed, will never run except for currently triggered call */
+    TriggerState["stop"] = "stop";
+})(TriggerState || (TriggerState = {}));

package/lib/cron.d.ts

@@ -13,9 +13,9 @@
  * 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.
  * 
  */
-import { Logger } from "@keeex/log";
+import { type Logger } from "@keeex/log";
 import ScheduledTask from "./cron/scheduledtask.js";
-import { TaskFunction, TaskOptions, Overrun, CompleteTaskOptions } from "./cron/types.js";
+import { type TaskFunction, type TaskOptions, Overrun, type CompleteTaskOptions } from "./cron/types.js";
 export { Overrun };
 export type { ScheduledTask, TaskFunction, TaskOptions, CompleteTaskOptions };
 /**

package/lib/cron.js

@@ -14,7 +14,7 @@
  * 
  */
 import ScheduledTask from "./cron/scheduledtask.js";
-import { Overrun } from "./cron/types.js";
+import { Overrun, } from "./cron/types.js";
 const scheduledTasks = [];
 export { Overrun };
 /**

package/lib/marshalling/marshaller.d.ts

@@ -23,7 +23,7 @@ export default class Marshaller {
     private constructor();
     static readonly start: (magicNumbers?: string) => Marshaller;
     /** End building the buffer and returns the result */
-    readonly end: () => ArrayBuffer;
+    readonly end: () => Uint8Array;
     /** Append an utf-8 string */
     readonly str: (value: string) => this;
     /** Append a 32-bit unsigned int */

package/lib/promise.d.ts

@@ -13,7 +13,7 @@
  * 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.
  * 
  */
-import { Awaitable } from "./types/types.js";
+import { type Awaitable } from "./types/types.js";
 /**
  * Create a promise that resolves after a given delay.
  *
@@ -36,10 +36,29 @@ export type PromiseFunc<T> = () => Promise<T | void>;
  */
 export declare const firstTruthy: <T>(promiseFuncs: Array<PromiseFunc<T>>) => Promise<T>;
 type AwaitableFn<T> = () => Awaitable<T>;
+type ErrorHandler = boolean | ((e: Error) => void) | {
+    error: (e: unknown) => void;
+};
 /**
  * Drop a promise and silence any exception.
  *
  * This is to be used *only* on dropped promises to explicitly silence any warning.
+ *
+ * @param errorHandler - How to handle rejection
+ * If not provided or true, an error message is printed on the error output.
+ * If false, the error is silently ignored.
+ * If a function is provided, it is called with an Error object.
+ * If an object with an `error()` function is provided, this error function is called.
+ */
+export declare const dropPromise: <T>(promise: Awaitable<T> | AwaitableFn<T>, errorHandler?: ErrorHandler) => void;
+/**
+ * Wait for a promise to complete, but ignore rejection.
+
+ * @param errorHandler - How to handle rejection
+ * If not provided or false, the error is silently ignored.
+ * If true, an error message is printed on the error output.
+ * If a function is provided, it is called with an Error object.
+ * If an object with an `error()` function is provided, this error function is called.
  */
-export declare const dropPromise: <T>(promise: Awaitable<T> | AwaitableFn<T>) => void;
+export declare const ignorePromise: <T>(promise: Awaitable<T> | AwaitableFn<T>, errorHandler?: ErrorHandler) => Promise<void>;
 export {};

package/lib/promise.js

@@ -15,6 +15,7 @@
  */
 /* eslint-env node */
 import * as log from "@keeex/log";
+import { asError } from "./error.js";
 import { timeConvert } from "./units.js";
 /**
  * Create a promise that resolves after a given delay.
@@ -69,20 +70,58 @@ export const firstTruthy = async (promiseFuncs) => {
     throw new Error("No result");
 };
 const logger = log.createLogger("dropPromise");
+const handleError = (handler, outputDefault, error) => {
+    if (handler === undefined) {
+        if (outputDefault)
+            logger.error("Dropped promise rejected:", error);
+    }
+    else if (handler === true) {
+        logger.error("Dropped promise rejected:", error);
+    }
+    else if (typeof handler === "function") {
+        handler(asError(error));
+    }
+    else if (handler !== false) {
+        handler.error(error);
+    }
+};
 /**
  * Drop a promise and silence any exception.
  *
  * This is to be used *only* on dropped promises to explicitly silence any warning.
+ *
+ * @param errorHandler - How to handle rejection
+ * If not provided or true, an error message is printed on the error output.
+ * If false, the error is silently ignored.
+ * If a function is provided, it is called with an Error object.
+ * If an object with an `error()` function is provided, this error function is called.
  */
-export const dropPromise = (promise) => {
+export const dropPromise = (promise, errorHandler) => {
     if (typeof promise === "function") {
         dropPromise(promise());
         return;
     }
     if (promise instanceof Promise) {
         // eslint-disable-next-line promise/prefer-await-to-then
-        promise.catch((e) => {
-            logger.error("Dropped promise rejected:", e);
-        });
+        promise.catch((e) => handleError(errorHandler, true, e));
+    }
+};
+/**
+ * Wait for a promise to complete, but ignore rejection.
+
+ * @param errorHandler - How to handle rejection
+ * If not provided or false, the error is silently ignored.
+ * If true, an error message is printed on the error output.
+ * If a function is provided, it is called with an Error object.
+ * If an object with an `error()` function is provided, this error function is called.
+ */
+export const ignorePromise = async (promise, errorHandler) => {
+    try {
+        if (typeof promise === "function")
+            return await ignorePromise(promise());
+        await promise;
+    }
+    catch (e) {
+        handleError(errorHandler, false, e);
     }
 };

package/lib/triggers.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+import { type Logger } from "@keeex/log";
+import type * as types from "./bits/triggers/types.js";
+/** Return a simple trigger that is run after the initial delay is passed after a trigger call */
+export declare const simpleTrigger: (handler: types.TriggerHandler, delayMs: number, logger?: Logger) => types.Trigger;
+/** Return a debouncing trigger that will rearm as long as it is triggered during the grace delay */
+export declare const debouncingTrigger: (handler: types.TriggerHandler, delayMs: number, logger?: Logger) => types.Trigger;

package/lib/triggers.js

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+import { DebounceTrigger } from "./bits/triggers/debounce.js";
+import { GrenadeTrigger } from "./bits/triggers/grenade.js";
+/** Return a simple trigger that is run after the initial delay is passed after a trigger call */
+export const simpleTrigger = (handler, delayMs, logger) => new GrenadeTrigger(handler, delayMs, logger);
+/** Return a debouncing trigger that will rearm as long as it is triggered during the grace delay */
+export const debouncingTrigger = (handler, delayMs, logger) => new DebounceTrigger(handler, delayMs, logger);

package/lib/types/array.d.ts

@@ -13,7 +13,7 @@
  * 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.
  * 
  */
-import { PredicateOptions, TypePredicate } from "./types.js";
+import * as types from "./types.js";
 /** Shorthand for an object that can be either T or an array of T */
 export type Arrayable<T> = Array<T> | T;
 /**
@@ -21,14 +21,14 @@ export type Arrayable<T> = Array<T> | T;
  *
  * @public
  */
-export declare const isStringArray: TypePredicate<Array<string>>;
+export declare const isStringArray: types.TypePredicate<Array<string>>;
 /**
  * Check that a given object is an array where each value have the given type.
  *
  * @public
  */
-export declare const isArrayOfType: <T>(obj: unknown, predicate: TypePredicate<T>, options?: PredicateOptions) => obj is Array<T>;
-export declare const isArrayableOfType: <T>(obj: unknown, predicate: TypePredicate<T>, options?: PredicateOptions) => obj is Arrayable<T>;
+export declare const isArrayOfType: <T>(obj: unknown, predicate: types.TypePredicate<T>, options?: types.PredicateOptions) => obj is Array<T>;
+export declare const isArrayableOfType: <T>(obj: unknown, predicate: types.TypePredicate<T>, options?: types.PredicateOptions) => obj is Arrayable<T>;
 /** @public */
-export declare const makeArrayOfTypePredicate: <ValueType>(valuePredicate: TypePredicate<ValueType>) => TypePredicate<Array<ValueType>>;
-export declare const makeArrayableOfTypePredicate: <ValueType>(valuePredicate: TypePredicate<ValueType>) => TypePredicate<Arrayable<ValueType>>;
+export declare const makeArrayOfTypePredicate: <ValueType>(valuePredicate: types.TypePredicate<ValueType>) => types.TypePredicate<Array<ValueType>>;
+export declare const makeArrayableOfTypePredicate: <ValueType>(valuePredicate: types.TypePredicate<ValueType>) => types.TypePredicate<Arrayable<ValueType>>;

package/lib/types/array.js

@@ -14,7 +14,7 @@
  * 
  */
 import { PredicateError } from "./predicateerror.js";
-import { getPredicateOptions } from "./types.js";
+import * as types from "./types.js";
 // #endregion
 /**
  * Check that a given object is an array of string
@@ -22,7 +22,7 @@ import { getPredicateOptions } from "./types.js";
  * @public
  */
 export const isStringArray = (obj, options = false) => {
-    const opt = getPredicateOptions(options);
+    const opt = types.getPredicateOptions(options);
     if (!Array.isArray(obj)) {
         PredicateError.expected(opt.raise, undefined, "an array");
         return false;
@@ -41,7 +41,7 @@ export const isStringArray = (obj, options = false) => {
  * @public
  */
 export const isArrayOfType = (obj, predicate, options = false) => {
-    const opt = getPredicateOptions(options);
+    const opt = types.getPredicateOptions(options);
     if (!Array.isArray(obj)) {
         PredicateError.expected(opt.raise, undefined, "an array");
         return false;

package/lib/types/enum.d.ts

@@ -13,7 +13,7 @@
  * 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.
  * 
  */
-import { PredicateOptions, TypePredicate } from "./types.js";
+import * as types from "./types.js";
 /**
  * Return an enum-type value whose key matches the provided key string.
  *
@@ -25,6 +25,6 @@ export declare const keyToEnum: <EnumType>(key: string, enumType: Record<string,
  *
  * @public
  */
-export declare const isEnumType: <EnumType>(obj: unknown, enumType: unknown, options?: PredicateOptions) => obj is EnumType;
+export declare const isEnumType: <EnumType>(obj: unknown, enumType: unknown, options?: types.PredicateOptions) => obj is EnumType;
 /** @public */
-export declare const makeEnumTypePredicate: <EnumType>(enumType: unknown) => TypePredicate<EnumType>;
+export declare const makeEnumTypePredicate: <EnumType>(enumType: unknown) => types.TypePredicate<EnumType>;

package/lib/types/enum.js

@@ -14,7 +14,7 @@
  * 
  */
 import { PredicateError } from "./predicateerror.js";
-import { getPredicateOptions } from "./types.js";
+import * as types from "./types.js";
 /**
  * Return an enum-type value whose key matches the provided key string.
  *
@@ -34,7 +34,7 @@ export const keyToEnum = (key, enumType) => {
  * @public
  */
 export const isEnumType = (obj, enumType, options = false) => {
-    const opt = getPredicateOptions(options);
+    const opt = types.getPredicateOptions(options);
     const res = Object.values(enumType).includes(obj);
     if (!res)
         PredicateError.expected(opt.raise, undefined, "value from enum");

package/lib/types/record.d.ts

@@ -13,7 +13,7 @@
  * 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.
  * 
  */
-import { PredicateOptions, TypePredicate } from "./types.js";
+import * as types from "./types.js";
 interface ProfileValue<T = unknown> {
     value: T;
     optional?: boolean;
@@ -25,12 +25,12 @@ interface InstanceOfValue {
     shortcut?: boolean;
 }
 interface PredicateValue<T = unknown> {
-    predicate: TypePredicate<T>;
+    predicate: types.TypePredicate<T>;
     optional?: boolean;
     shortcut?: boolean;
 }
 type AdvancedProfileValue = ProfileValue | InstanceOfValue | PredicateValue;
-type ProfileEntryType = string | TypePredicate | AdvancedProfileValue;
+type ProfileEntryType = string | types.TypePredicate | AdvancedProfileValue;
 /**
  * Simple profile to check.
  *
@@ -49,19 +49,19 @@ export type Profile<T> = Record<keyof T, ProfileEntryType | Array<ProfileEntryTy
  *
  * @public
  */
-export declare const isObjectProfile: <T>(obj: unknown, profile: Profile<T>, options?: PredicateOptions) => obj is T;
+export declare const isObjectProfile: <T>(obj: unknown, profile: Profile<T>, options?: types.PredicateOptions) => obj is T;
 /**
  * Create a predicate function based on the given profile.
  *
  * @public
  */
-export declare const makeProfilePredicate: <TargetType>(profile: Profile<TargetType>) => TypePredicate<TargetType>;
+export declare const makeProfilePredicate: <TargetType>(profile: Profile<TargetType>) => types.TypePredicate<TargetType>;
 /**
  * Check if all of an object properties match a given type.
  *
  * @public
  */
-export declare const isKeyValueOfType: <ValueType>(obj: unknown, typePredicate: TypePredicate<ValueType>, options?: PredicateOptions) => obj is Record<string, ValueType>;
+export declare const isKeyValueOfType: <ValueType>(obj: unknown, typePredicate: types.TypePredicate<ValueType>, options?: types.PredicateOptions) => obj is Record<string, ValueType>;
 /** @public */
-export declare const makeKeyValueOfTypePredicate: <ValueType>(typePredicate: TypePredicate<ValueType>) => TypePredicate<Record<string, ValueType>>;
+export declare const makeKeyValueOfTypePredicate: <ValueType>(typePredicate: types.TypePredicate<ValueType>) => types.TypePredicate<Record<string, ValueType>>;
 export {};

package/lib/types/record.js

@@ -15,7 +15,7 @@
  */
 import { asError } from "../error.js";
 import { PredicateError } from "./predicateerror.js";
-import { getPredicateOptions, } from "./types.js";
+import * as types from "./types.js";
 /**
  * Extract modifiers from primitive type name
  *
@@ -180,7 +180,7 @@ const checkArrayTypeDef = (valueType, rec, keyName, options) => {
  * @public
  */
 export const isObjectProfile = (obj, profile, options = false) => {
-    const opt = getPredicateOptions(options);
+    const opt = types.getPredicateOptions(options);
     if (typeof obj !== "object" || obj === null) {
         PredicateError.predicateFailed(opt.raise, "root");
         return false;
@@ -210,7 +210,7 @@ export const makeProfilePredicate = (profile) => (obj, options = false) => isObj
  * @public
  */
 export const isKeyValueOfType = (obj, typePredicate, options = false) => {
-    const opt = getPredicateOptions(options);
+    const opt = types.getPredicateOptions(options);
     if (typeof obj !== "object") {
         PredicateError.predicateFailed(opt.raise, undefined);
         return false;

package/lib/types/utils.d.ts

@@ -13,8 +13,9 @@
  * 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.
  * 
  */
-import ms from "ms";
+import * as types from "./types.js";
+import type ms from "ms";
 /** Check that the argument match the string portion of `ms()` */
-export declare const isMsStringValue: import("./types.js").TypePredicate<ms.StringValue>;
+export declare const isMsStringValue: types.TypePredicate<ms.StringValue>;
 /** Check that a value is suitable for input for `ms()` */
-export declare const isMsInput: import("./types.js").TypePredicate<number | ms.StringValue>;
+export declare const isMsInput: types.TypePredicate<number | ms.StringValue>;

package/lib/types/utils.js

@@ -14,7 +14,7 @@
  * 
  */
 import { isNumber } from "./primitive.js";
-import { makeOrPredicate, makeTemplatePredicate } from "./types.js";
+import * as types from "./types.js";
 /** All `ms()` units, extracted from type definition */
 const msBaseUnits = [
     "Years",
@@ -55,14 +55,21 @@ const msUnitAnyCase = Array.from(new Set([
     ...msBaseUnits.map((c) => c.toUpperCase()),
     ...msBaseUnits.map((c) => c.toLowerCase()),
 ]));
-const isMsStrInput = makeTemplatePredicate("${number}");
-const isMsStrUnitPredicate = makeTemplatePredicate("${number}${msUnitAnyCase}", { msUnitAnyCase });
-const isMsSpaceUnitPredicate = makeTemplatePredicate("${number} ${msUnitAnyCase}", { msUnitAnyCase });
+const isMsStrInput = types.makeTemplatePredicate("${number}");
+const isMsStrUnitPredicate = types.makeTemplatePredicate("${number}${msUnitAnyCase}", {
+    msUnitAnyCase,
+});
+const isMsSpaceUnitPredicate = types.makeTemplatePredicate("${number} ${msUnitAnyCase}", {
+    msUnitAnyCase,
+});
 /** Check that the argument match the string portion of `ms()` */
-export const isMsStringValue = makeOrPredicate([
+export const isMsStringValue = types.makeOrPredicate([
     isMsStrInput,
     isMsStrUnitPredicate,
     isMsSpaceUnitPredicate,
 ]);
 /** Check that a value is suitable for input for `ms()` */
-export const isMsInput = makeOrPredicate([isNumber, isMsStringValue]);
+export const isMsInput = types.makeOrPredicate([
+    isNumber,
+    isMsStringValue,
+]);

package/package.json

@@ -1 +1 @@
-{"name":"@keeex/utils","version":"7.2.1","description":"Various utility functions for pure JavaScript","scripts":{},"author":"KeeeX SAS","contributors":[{"name":"Gabriel Paul \"Cley Faye\" Risterucci","email":"gabriel@keeex.net"}],"homepage":"https://keeex.me/oss","keywords":["utility"],"type":"module","license":"MIT","dependencies":{"@keeex/bubble_babble":"^3.0.1","@keeex/log":"^1.7.1","base64-arraybuffer":"^1.0.2","cron-parser":"^5.2.0","ms":"^2.1.3","text-encoding-shim":"^1.0.5"},"exports":{"./units.js":{"node":"./lib/units.js","browser":"./web/units.js","default":"./lib/units.js"},"./uint8array.js":{"node":"./lib/uint8array.js","browser":"./web/uint8array.js","default":"./lib/uint8array.js"},"./string.js":{"node":"./lib/string.js","browser":"./web/string.js","default":"./lib/string.js"},"./starttime.js":{"node":"./lib/starttime.js","browser":"./web/starttime.js","default":"./lib/starttime.js"},"./promise.js":{"node":"./lib/promise.js","browser":"./web/promise.js","default":"./lib/promise.js"},"./path.js":{"node":"./lib/path.js","browser":"./web/path.js","default":"./lib/path.js"},"./number.js":{"node":"./lib/number.js","browser":"./web/number.js","default":"./lib/number.js"},"./linebuffer.js":{"node":"./lib/linebuffer.js","browser":"./web/linebuffer.js","default":"./lib/linebuffer.js"},"./json.js":{"node":"./lib/json.js","browser":"./web/json.js","default":"./lib/json.js"},"./idx.js":{"node":"./lib/idx.js","browser":"./web/idx.js","default":"./lib/idx.js"},"./hex.js":{"node":"./lib/hex.js","browser":"./web/hex.js","default":"./lib/hex.js"},"./global.js":{"node":"./lib/global.js","browser":"./web/global.js","default":"./lib/global.js"},"./error.js":{"node":"./lib/error.js","browser":"./web/error.js","default":"./lib/error.js"},"./dict.js":{"node":"./lib/dict.js","browser":"./web/dict.js","default":"./lib/dict.js"},"./cron.js":{"node":"./lib/cron.js","browser":"./web/cron.js","default":"./lib/cron.js"},"./consts.js":{"node":"./lib/consts.js","browser":"./web/consts.js","default":"./lib/consts.js"},"./bytebuffer.js":{"node":"./lib/bytebuffer.js","browser":"./web/bytebuffer.js","default":"./lib/bytebuffer.js"},"./benchmark.js":{"node":"./lib/benchmark.js","browser":"./web/benchmark.js","default":"./lib/benchmark.js"},"./base64.js":{"node":"./lib/base64.js","browser":"./web/base64.js","default":"./lib/base64.js"},"./base58.js":{"node":"./lib/base58.js","browser":"./web/base58.js","default":"./lib/base58.js"},"./arraybuffer.js":{"node":"./lib/arraybuffer.js","browser":"./web/arraybuffer.js","default":"./lib/arraybuffer.js"},"./array.js":{"node":"./lib/array.js","browser":"./web/array.js","default":"./lib/array.js"},"./types/utils.js":{"node":"./lib/types/utils.js","browser":"./web/types/utils.js","default":"./lib/types/utils.js"},"./types/types.js":{"node":"./lib/types/types.js","browser":"./web/types/types.js","default":"./lib/types/types.js"},"./types/record.js":{"node":"./lib/types/record.js","browser":"./web/types/record.js","default":"./lib/types/record.js"},"./types/primitive.js":{"node":"./lib/types/primitive.js","browser":"./web/types/primitive.js","default":"./lib/types/primitive.js"},"./types/predicateerror.js":{"node":"./lib/types/predicateerror.js","browser":"./web/types/predicateerror.js","default":"./lib/types/predicateerror.js"},"./types/enum.js":{"node":"./lib/types/enum.js","browser":"./web/types/enum.js","default":"./lib/types/enum.js"},"./types/array.js":{"node":"./lib/types/array.js","browser":"./web/types/array.js","default":"./lib/types/array.js"},"./marshalling/unmarshaller.js":{"node":"./lib/marshalling/unmarshaller.js","browser":"./web/marshalling/unmarshaller.js","default":"./lib/marshalling/unmarshaller.js"},"./marshalling/marshaller.js":{"node":"./lib/marshalling/marshaller.js","browser":"./web/marshalling/marshaller.js","default":"./lib/marshalling/marshaller.js"},"./async/timecache.js":{"node":"./lib/async/timecache.js","browser":"./web/async/timecache.js","default":"./lib/async/timecache.js"},"./async/queues.js":{"node":"./lib/async/queues.js","browser":"./web/async/queues.js","default":"./lib/async/queues.js"},"./async/keycache.js":{"node":"./lib/async/keycache.js","browser":"./web/async/keycache.js","default":"./lib/async/keycache.js"},"./async/deferredpromise.js":{"node":"./lib/async/deferredpromise.js","browser":"./web/async/deferredpromise.js","default":"./lib/async/deferredpromise.js"},"./async/asynctrigger.js":{"node":"./lib/async/asynctrigger.js","browser":"./web/async/asynctrigger.js","default":"./lib/async/asynctrigger.js"}},"files":["/lib","/web"]}
+{"name":"@keeex/utils","version":"7.4.0","description":"Various utility functions for pure JavaScript","scripts":{},"author":"KeeeX SAS","contributors":[{"name":"Gabriel Paul \"Cley Faye\" Risterucci","email":"gabriel@keeex.net"}],"homepage":"https://keeex.me/oss","keywords":["utility"],"type":"module","license":"MIT","dependencies":{"@keeex/bubble_babble":"^3.0.1","@keeex/log":"^1.7.1","base64-arraybuffer":"^1.0.2","cron-parser":"^5.3.0","ms":"^2.1.3","text-encoding-shim":"^1.0.5"},"exports":{"./array.js":{"node":"./lib/array.js","browser":"./web/array.js","react-native":"./web/array.js","default":"./lib/array.js"},"./arraybuffer.js":{"node":"./lib/arraybuffer.js","browser":"./web/arraybuffer.js","react-native":"./web/arraybuffer.js","default":"./lib/arraybuffer.js"},"./async/asynctrigger.js":{"node":"./lib/async/asynctrigger.js","browser":"./web/async/asynctrigger.js","react-native":"./web/async/asynctrigger.js","default":"./lib/async/asynctrigger.js"},"./async/deferredpromise.js":{"node":"./lib/async/deferredpromise.js","browser":"./web/async/deferredpromise.js","react-native":"./web/async/deferredpromise.js","default":"./lib/async/deferredpromise.js"},"./async/eventqueue.js":{"node":"./lib/async/eventqueue.js","browser":"./web/async/eventqueue.js","react-native":"./web/async/eventqueue.js","default":"./lib/async/eventqueue.js"},"./async/keycache.js":{"node":"./lib/async/keycache.js","browser":"./web/async/keycache.js","react-native":"./web/async/keycache.js","default":"./lib/async/keycache.js"},"./async/queues.js":{"node":"./lib/async/queues.js","browser":"./web/async/queues.js","react-native":"./web/async/queues.js","default":"./lib/async/queues.js"},"./async/timecache.js":{"node":"./lib/async/timecache.js","browser":"./web/async/timecache.js","react-native":"./web/async/timecache.js","default":"./lib/async/timecache.js"},"./base58.js":{"node":"./lib/base58.js","browser":"./web/base58.js","react-native":"./web/base58.js","default":"./lib/base58.js"},"./base64.js":{"node":"./lib/base64.js","browser":"./web/base64.js","react-native":"./web/base64.js","default":"./lib/base64.js"},"./benchmark.js":{"node":"./lib/benchmark.js","browser":"./web/benchmark.js","react-native":"./web/benchmark.js","default":"./lib/benchmark.js"},"./bytebuffer.js":{"node":"./lib/bytebuffer.js","browser":"./web/bytebuffer.js","react-native":"./web/bytebuffer.js","default":"./lib/bytebuffer.js"},"./consts.js":{"node":"./lib/consts.js","browser":"./web/consts.js","react-native":"./web/consts.js","default":"./lib/consts.js"},"./cron.js":{"node":"./lib/cron.js","browser":"./web/cron.js","react-native":"./web/cron.js","default":"./lib/cron.js"},"./dict.js":{"node":"./lib/dict.js","browser":"./web/dict.js","react-native":"./web/dict.js","default":"./lib/dict.js"},"./error.js":{"node":"./lib/error.js","browser":"./web/error.js","react-native":"./web/error.js","default":"./lib/error.js"},"./global.js":{"node":"./lib/global.js","browser":"./web/global.js","react-native":"./web/global.js","default":"./lib/global.js"},"./hex.js":{"node":"./lib/hex.js","browser":"./web/hex.js","react-native":"./web/hex.js","default":"./lib/hex.js"},"./idx.js":{"node":"./lib/idx.js","browser":"./web/idx.js","react-native":"./web/idx.js","default":"./lib/idx.js"},"./json.js":{"node":"./lib/json.js","browser":"./web/json.js","react-native":"./web/json.js","default":"./lib/json.js"},"./linebuffer.js":{"node":"./lib/linebuffer.js","browser":"./web/linebuffer.js","react-native":"./web/linebuffer.js","default":"./lib/linebuffer.js"},"./marshalling/marshaller.js":{"node":"./lib/marshalling/marshaller.js","browser":"./web/marshalling/marshaller.js","react-native":"./web/marshalling/marshaller.js","default":"./lib/marshalling/marshaller.js"},"./marshalling/unmarshaller.js":{"node":"./lib/marshalling/unmarshaller.js","browser":"./web/marshalling/unmarshaller.js","react-native":"./web/marshalling/unmarshaller.js","default":"./lib/marshalling/unmarshaller.js"},"./number.js":{"node":"./lib/number.js","browser":"./web/number.js","react-native":"./web/number.js","default":"./lib/number.js"},"./path.js":{"node":"./lib/path.js","browser":"./web/path.js","react-native":"./web/path.js","default":"./lib/path.js"},"./promise.js":{"node":"./lib/promise.js","browser":"./web/promise.js","react-native":"./web/promise.js","default":"./lib/promise.js"},"./starttime.js":{"node":"./lib/starttime.js","browser":"./web/starttime.js","react-native":"./web/starttime.js","default":"./lib/starttime.js"},"./string.js":{"node":"./lib/string.js","browser":"./web/string.js","react-native":"./web/string.js","default":"./lib/string.js"},"./triggers.js":{"node":"./lib/triggers.js","browser":"./web/triggers.js","react-native":"./web/triggers.js","default":"./lib/triggers.js"},"./types/array.js":{"node":"./lib/types/array.js","browser":"./web/types/array.js","react-native":"./web/types/array.js","default":"./lib/types/array.js"},"./types/enum.js":{"node":"./lib/types/enum.js","browser":"./web/types/enum.js","react-native":"./web/types/enum.js","default":"./lib/types/enum.js"},"./types/predicateerror.js":{"node":"./lib/types/predicateerror.js","browser":"./web/types/predicateerror.js","react-native":"./web/types/predicateerror.js","default":"./lib/types/predicateerror.js"},"./types/primitive.js":{"node":"./lib/types/primitive.js","browser":"./web/types/primitive.js","react-native":"./web/types/primitive.js","default":"./lib/types/primitive.js"},"./types/record.js":{"node":"./lib/types/record.js","browser":"./web/types/record.js","react-native":"./web/types/record.js","default":"./lib/types/record.js"},"./types/types.js":{"node":"./lib/types/types.js","browser":"./web/types/types.js","react-native":"./web/types/types.js","default":"./lib/types/types.js"},"./types/utils.js":{"node":"./lib/types/utils.js","browser":"./web/types/utils.js","react-native":"./web/types/utils.js","default":"./lib/types/utils.js"},"./uint8array.js":{"node":"./lib/uint8array.js","browser":"./web/uint8array.js","react-native":"./web/uint8array.js","default":"./lib/uint8array.js"},"./units.js":{"node":"./lib/units.js","browser":"./web/units.js","react-native":"./web/units.js","default":"./lib/units.js"}},"files":["/lib","/web"]}

package/web/async/eventqueue.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * 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.
+ * 
+ */
+import * as kxLog from "@keeex/log";
+import { type Awaitable } from "../types/types.js";
+export type EventHandler<DataType> = DataType extends undefined ? () => Awaitable<void> : (data: DataType) => Awaitable<void>;
+/** Function used to merge multiple events into one */
+export type MergeFunc<DataType> = (pendingData: Array<DataType>) => Awaitable<DataType>;
+/**
+ * Provides asynchronous handling of a sequential event queue.
+ *
+ * This should work as a regular sequential event queue, except that the handling of these events
+ * can be done using asynchronous functions.
+ * All handlers will be called on all input events in the order they came in, but there is no
+ * guarantee on the *order* of the event handlers when there is more than one.
+ *
+ * More events can be triggered while some events are processed, in which case they'll cause more
+ * calls to the handlers as needed.
+ */
+export declare class EventQueue<DataType> {
+    #private;
+    constructor(merger?: MergeFunc<DataType>, logger?: kxLog.Logger);
+    addHandler: (handler: EventHandler<DataType>) => void;
+    removeHandler: (handler: EventHandler<DataType>) => void;
+    /**
+     * Cancel all pending events.
+     *
+     * Currently pending events that are not being processed are dropped.
+     * This does not prevent more events from being sent, and will not stop current processing.
+     */
+    cancelAll: () => void;
+    /**
+     * Disable all further event processing.
+     *
+     * This will not stop current processing.
+     */
+    close: (cancelAll?: boolean) => void;
+    /**
+     * Wait for all handlers to complete.
+     *
+     * If there are currently events being processed, this will wait until they are all processed.
+     * If more events show up while waiting, it will wait for those events to be processed too.
+     * If there are no events currently being processed, it will resolve immediately.
+     */
+    wait: () => Promise<void>;
+    /** Trigger an event to be handled */
+    trigger: (data: DataType) => void;
+}