@daiso-tech/core 0.33.0 → 0.35.0

package/dist/async/utilities/promise-queue/promise-queue.js

@@ -0,0 +1,107 @@
+/**
+ * @module Async
+ */
+import {} from "../../../utilities/_module-exports.js";
+import { LazyPromise } from "../../../async/utilities/_module.js";
+import { v4 } from "uuid";
+import { CapacityFullAsyncError } from "../../../async/async.errors.js";
+/**
+ * @internal
+ */
+class Queue {
+    array = [];
+    size() {
+        return this.array.length;
+    }
+    enqueue(value) {
+        this.array.push(value);
+    }
+    dequeue() {
+        return this.array.shift() ?? null;
+    }
+}
+/**
+ * @internal
+ */
+export class PromiseQueue {
+    settings;
+    queue = new Queue();
+    listeners = new Map();
+    constructor(settings) {
+        this.settings = settings;
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        this.start();
+    }
+    async start() {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, no-constant-condition
+        while (true) {
+            await Promise.all(this.getItems().map((item) => this.process(item)));
+            await LazyPromise.delay(this.settings.interval);
+        }
+    }
+    getItems() {
+        const values = [];
+        for (let i = 0; i < this.settings.maxConcurrency; i++) {
+            const item = this.queue.dequeue();
+            if (item === null) {
+                continue;
+            }
+            values.push(item);
+        }
+        return values;
+    }
+    async process(item) {
+        const listener = this.listeners.get(item.id);
+        try {
+            if (item.signal.aborted) {
+                listener?.([null, item.signal.reason]);
+                return;
+            }
+            const value = await item.func(item.signal);
+            listener?.([value, null]);
+        }
+        catch (error) {
+            listener?.([null, error]);
+            throw error;
+        }
+    }
+    enqueue(func, signal) {
+        const id = v4();
+        if (this.settings.maxCapacity === null) {
+            this.queue.enqueue({
+                id,
+                func,
+                signal,
+            });
+        }
+        else if (this.queue.size() <= this.settings.maxCapacity) {
+            this.queue.enqueue({ id, func, signal });
+        }
+        else {
+            throw new CapacityFullAsyncError(`Max capacity reached, ${String(this.settings.maxCapacity)} items allowed.`);
+        }
+        return id;
+    }
+    listenOnce(id, listener) {
+        this.listeners.set(id, listener);
+    }
+    asPromise(id) {
+        return new Promise((resolve, reject) => {
+            this.listenOnce(id, ([value, error]) => {
+                if (value === null) {
+                    // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
+                    reject(error);
+                    return;
+                }
+                resolve(value);
+            });
+        });
+    }
+    /**
+     * @throws {CapacityFullAsyncError} {@link CapacityFullAsyncError}
+     */
+    add(func, signal) {
+        return this.asPromise(this.enqueue(func, signal));
+    }
+}
+//# sourceMappingURL=promise-queue.js.map

package/dist/async/utilities/promise-queue/promise-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise-queue.js","sourceRoot":"","sources":["../../../../src/async/utilities/promise-queue/promise-queue.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAIN,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEjE;;GAEG;AACH,MAAM,KAAK;IACU,KAAK,GAAa,EAAE,CAAC;IAEtC,IAAI;QACA,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,OAAO,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,IAAI,CAAC;IACtC,CAAC;CACJ;AA2BD;;GAEG;AACH,MAAM,OAAO,YAAY;IAKQ;IAJZ,KAAK,GAAG,IAAI,KAAK,EAA6B,CAAC;IAE/C,SAAS,GAAG,IAAI,GAAG,EAAqC,CAAC;IAE1E,YAA6B,QAA8B;QAA9B,aAAQ,GAAR,QAAQ,CAAsB;QACvD,mEAAmE;QACnE,IAAI,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,KAAK;QACf,8FAA8F;QAC9F,OAAO,IAAI,EAAE,CAAC;YACV,MAAM,OAAO,CAAC,GAAG,CACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CACpD,CAAC;YACF,MAAM,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACpD,CAAC;IACL,CAAC;IAEO,QAAQ;QACZ,MAAM,MAAM,GAA+B,EAAE,CAAC;QAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,IAAI,GACN,IAAI,CAAC,KAAK,CAAC,OAAO,EAAqC,CAAC;YAC5D,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAChB,SAAS;YACb,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,OAAO,CACjB,IAA8B;QAE9B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAE7C,IAAI,CAAC;YACD,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACtB,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvC,OAAO;YACX,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3C,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;YAE1B,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;IAEO,OAAO,CACX,IAA4D,EAC5D,MAAmB;QAEnB,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;QAChB,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;YACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;gBACf,EAAE;gBACF,IAAI;gBACJ,MAAM;aACT,CAAC,CAAC;QACP,CAAC;aAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;YACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAC7C,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,sBAAsB,CAC5B,yBAAyB,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAC9E,CAAC;QACN,CAAC;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAEO,UAAU,CACd,EAAU,EACV,QAAsC;QAEtC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;IAEO,SAAS,CAAS,EAAU;QAChC,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE;gBACnC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACjB,2EAA2E;oBAC3E,MAAM,CAAC,KAAK,CAAC,CAAC;oBACd,OAAO;gBACX,CAAC;gBACD,OAAO,CAAC,KAAe,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,GAAG,CACC,IAA4D,EAC5D,MAAmB;QAEnB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;CACJ"}

package/dist/async/utilities/timeout-and-fail/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../async/utilities/timeout-and-fail/timeout-and-fail.js";

package/dist/async/utilities/timeout-and-fail/_module.js

@@ -0,0 +1,2 @@
+export * from "../../../async/utilities/timeout-and-fail/timeout-and-fail.js";
+//# sourceMappingURL=_module.js.map

package/dist/async/utilities/timeout-and-fail/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/async/utilities/timeout-and-fail/_module.ts"],"names":[],"mappings":"AAAA,cAAc,wDAAwD,CAAC"}

package/dist/async/utilities/timeout-and-fail/timeout-and-fail.d.ts

@@ -0,0 +1,7 @@
+import type { TimeSpan } from "../../../utilities/_module-exports.js";
+/**
+ * @throws {TimeoutAsyncError} {@link TimeoutAsyncError}
+ *
+ * @internal
+ */
+export declare function timeoutAndFail<TValue>(promise: PromiseLike<TValue>, time: TimeSpan, abort: (rejection: unknown) => void, signal: AbortSignal): Promise<TValue>;

package/dist/async/utilities/timeout-and-fail/timeout-and-fail.js

@@ -0,0 +1,19 @@
+import { TimeoutAsyncError } from "../../../async/async.errors.js";
+import { abortAndFail } from "../../../async/utilities/abort-and-fail/_module.js";
+/**
+ * @throws {TimeoutAsyncError} {@link TimeoutAsyncError}
+ *
+ * @internal
+ */
+export async function timeoutAndFail(promise, time, abort, signal) {
+    const timeoutId = setTimeout(() => {
+        abort(new TimeoutAsyncError("The promise exceded time"));
+    }, time.toMilliseconds());
+    try {
+        return await abortAndFail(promise, signal);
+    }
+    finally {
+        clearTimeout(timeoutId);
+    }
+}
+//# sourceMappingURL=timeout-and-fail.js.map

package/dist/async/utilities/timeout-and-fail/timeout-and-fail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeout-and-fail.js","sourceRoot":"","sources":["../../../../src/async/utilities/timeout-and-fail/timeout-and-fail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAE3E;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAChC,OAA4B,EAC5B,IAAc,EACd,KAAmC,EACnC,MAAmB;IAEnB,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;QAC9B,KAAK,CAAC,IAAI,iBAAiB,CAAC,0BAA0B,CAAC,CAAC,CAAC;IAC7D,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;IAC1B,IAAI,CAAC;QACD,OAAO,MAAM,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;YAAS,CAAC;QACP,YAAY,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;AACL,CAAC"}

package/dist/cache/contracts/cache-adapter.contract.d.ts

@@ -3,52 +3,52 @@
  */
 import type { TimeSpan } from "../../utilities/_module-exports.js";
 /**
- * The <i>ICacheAdapter</i> contract defines a way for key-value pairs independent of data storage.
+ * The `ICacheAdapter` contract defines a way for key-value pairs independent of data storage.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Contracts
  */
 export type ICacheAdapter<TType = unknown> = {
     /**
-     * The <i>get</i> method returns the value when <i>key</i> is found otherwise null will be returned.
+     * The `get` method returns the value when `key` is found otherwise null will be returned.
      */
     get(key: string): PromiseLike<TType | null>;
     /**
-     * The <i>getAndRemove</i> method returns the value when <i>key</i> is found otherwise null will be returned.
+     * The `getAndRemove` method returns the value when `key` is found otherwise null will be returned.
      * The key will be removed after it is returned.
      */
     getAndRemove(key: string): PromiseLike<TType | null>;
     /**
-     * The <i>add</i> method adds a <i>key</i> with given <i>value</i> when key doesn't exists. Returns true when key doesn't exists otherwise false will be returned.
-     * You can provide a <i>ttl</i> value. If null is passed, the item will not expire.
+     * The `add` method adds a `key` with given `value` when key doesn't exists. Returns true when key doesn't exists otherwise false will be returned.
+     * You can provide a `ttl` value. If null is passed, the item will not expire.
      */
     add(key: string, value: TType, ttl: TimeSpan | null): PromiseLike<boolean>;
     /**
-     * The <i>put</i> method replaces th given <i>key</i> with the given <i>value</i> and <i>ttl</i> if the <i>key</i> exists othwerwise it will add the given <i>value</i> and <i>ttl</i>.
-     * Returns true if the <i>key</i> where replaced otherwise false is returned.
+     * The `put` method replaces th given `key` with the given `value` and `ttl` if the `key` exists othwerwise it will add the given `value` and `ttl`.
+     * Returns true if the `key` where replaced otherwise false is returned.
      */
     put(key: string, value: TType, ttl: TimeSpan | null): PromiseLike<boolean>;
     /**
-     * The <i>update</i> method updates the given <i>key</i> with given <i>value</i>. Returns true if the <i>key</i> where updated otherwise false will be returned.
+     * The `update` method updates the given `key` with given `value`. Returns true if the `key` where updated otherwise false will be returned.
      */
     update(key: string, value: TType): PromiseLike<boolean>;
     /**
-     * The <i>increment</i> method increments the given <i>key</i> with given <i>value</i>. Returns true if the <i>key</i> where incremented otherwise false will be returned.
-     * If <i>values</i> is not defined then it will increment the key with 1.
+     * The `increment` method increments the given `key` with given `value`. Returns true if the `key` where incremented otherwise false will be returned.
+     * If `values` is not defined then it will increment the key with 1.
      * An error will thrown if the key is not a number.
      * @throws {TypeCacheError} {@link TypeCacheError}
      */
     increment(key: string, value: number): PromiseLike<boolean>;
     /**
-     * The <i>removeMany</i> method removes many keys. Returns true if one of the keys where deleted otherwise false is returned.
+     * The `removeMany` method removes many keys. Returns true if one of the keys where deleted otherwise false is returned.
      */
     removeMany(keys: string[]): PromiseLike<boolean>;
     /**
-     * The <i>removeAll</i> method removes all keys from the cache.
+     * The `removeAll` method removes all keys from the cache.
      */
     removeAll(): PromiseLike<void>;
     /**
-     * The <i>removeByKeyPrefix</i> method removes all the keys in the cache that starts with the given <i>prefix</i>.
+     * The `removeByKeyPrefix` method removes all the keys in the cache that starts with the given `prefix`.
      */
     removeByKeyPrefix(prefix: string): PromiseLike<void>;
 };

package/dist/cache/contracts/cache-factory.contract.d.ts

@@ -3,14 +3,14 @@
  */
 import type { ICache } from "../../cache/contracts/cache.contract.js";
 /**
- * The <i>ICacheFactory</i> contract makes it easy to configure and switch between different <i>{@link ICache}</i> dynamically.
+ * The `ICacheFactory` contract makes it easy to configure and switch between different {@link ICache | `ICache`} dynamically.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Contracts
  */
 export type ICacheFactory<TAdapters extends string = string> = {
     /**
-     * The <i>use</i> method will throw an error if you provide it unregisted adapter.
+     * The `use` method will throw an error if you provide it unregisted adapter.
      * If no default adapter is defined an error will be thrown.
      * @throws {UnregisteredAdapterError} {@link UnregisteredAdapterError}
      * @throws {DefaultAdapterNotDefinedError} {@link DefaultAdapterNotDefinedError}

package/dist/cache/contracts/cache.contract.d.ts

@@ -4,91 +4,91 @@
 import type { LazyPromise } from "../../async/_module-exports.js";
 import type { TimeSpan } from "../../utilities/_module-exports.js";
 import type { AsyncLazyable, NoneFunc, OneOrMore } from "../../utilities/_module-exports.js";
-import type { CacheEvents } from "../../cache/contracts/cache.events.js";
+import type { CacheEventMap } from "../../cache/contracts/cache.events.js";
 import type { IEventListenable } from "../../event-bus/contracts/_module-exports.js";
 /**
- * The <i>ICacheListenable</i> contract defines a way for listening <i>{@link ICache}</i> operation events.
+ * The `ICacheListenable` contract defines a way for listening {@link ICache | `ICache`} operation events.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Contracts
  */
-export type ICacheListenable<TType = unknown> = IEventListenable<CacheEvents<TType>>;
+export type ICacheListenable<TType = unknown> = IEventListenable<CacheEventMap<TType>>;
 /**
- * The <i>ICacheBase</i> contract defines a way for as key-value pairs independent of data storage.
+ * The `ICacheBase` contract defines a way for as key-value pairs independent of data storage.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Contracts
  */
 export type ICacheBase<TType = unknown> = {
     /**
-     * The <i>exists</i> method returns true when <i>key</i> is found otherwise false will be returned.
+     * The `exists` method returns true when `key` is found otherwise false will be returned.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      */
     exists(key: OneOrMore<string>): LazyPromise<boolean>;
     /**
-     * The <i>missing</i> method returns true when <i>key</i> is not found otherwise false will be returned.
+     * The `missing` method returns true when `key` is not found otherwise false will be returned.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      */
     missing(key: OneOrMore<string>): LazyPromise<boolean>;
     /**
-     * The <i>get</i> method returns the value when <i>key</i> is found otherwise null will be returned.
+     * The `get` method returns the value when `key` is found otherwise null will be returned.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      */
     get(key: OneOrMore<string>): LazyPromise<TType | null>;
     /**
-     * The <i>getOrFail</i> method returns the value when <i>key</i> is found otherwise an error will be thrown.
+     * The `getOrFail` method returns the value when `key` is found otherwise an error will be thrown.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
      * @throws {KeyNotFoundCacheError} {@link KeyNotFoundCacheError}
      */
     getOrFail(key: OneOrMore<string>): LazyPromise<TType>;
     /**
-     * The <i>getAndRemove</i> method returns the value when <i>key</i> is found otherwise null will be returned.
+     * The `getAndRemove` method returns the value when `key` is found otherwise null will be returned.
      * The key will be removed after it is returned.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      */
     getAndRemove(key: OneOrMore<string>): LazyPromise<TType | null>;
     /**
-     * The <i>getOr</i> method will retrieve the given <i>key</i> if found otherwise <i>defaultValue</i> will be returned.
+     * The `getOr` method will retrieve the given `key` if found otherwise `defaultValue` will be returned.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
-     * @param defaultValue - can be regular value, sync or async <i>{@link Invokable}</i> value and <i>{@link LazyPromise}</i> value.
+     * @param defaultValue - can be regular value, sync or async {@link Invokable | `Invokable`} value and {@link LazyPromise| `LazyPromise`} value.
      */
     getOr(key: OneOrMore<string>, defaultValue: AsyncLazyable<NoneFunc<TType>>): LazyPromise<TType>;
     /**
-     * The <i>getOrAdd</i> method will retrieve the given <i>key</i> if found otherwise <i>valueToAdd</i> will be added and returned.
+     * The `getOrAdd` method will retrieve the given `key` if found otherwise `valueToAdd` will be added and returned.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
-     * @param valueToAdd - can be regular value, sync or async <i>{@link Invokable}</i> value and <i>{@link LazyPromise}</i> value.
+     * @param valueToAdd - can be regular value, sync or async {@link Invokable | `Invokable`} value and {@link LazyPromise| `LazyPromise`} value.
      */
     getOrAdd(key: OneOrMore<string>, valueToAdd: AsyncLazyable<NoneFunc<TType>>, ttl?: TimeSpan | null): LazyPromise<TType>;
     /**
-     * The <i>add</i> method adds a <i>key</i> with given <i>value</i> when key doesn't exists.
+     * The `add` method adds a `key` with given `value` when key doesn't exists.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
      * @param ttl - If null is passed, the item will not expire.
      *
@@ -96,87 +96,87 @@ export type ICacheBase<TType = unknown> = {
      */
     add(key: OneOrMore<string>, value: TType, ttl?: TimeSpan | null): LazyPromise<boolean>;
     /**
-     * The <i>put</i> method replaces th given <i>key</i> with the given <i>value</i> and <i>ttl</i> if the <i>key</i> exists
-     * othwerwise it will add the given <i>value</i> with the given <i>ttl</i>.
+     * The `put` method replaces th given `key` with the given `value` and `ttl` if the `key` exists
+     * othwerwise it will add the given `value` with the given `ttl`.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
      * @param ttl - If null is passed, the item will not expire.
      *
-     * @returns true if the <i>key</i> where replaced otherwise false is returned.
+     * @returns true if the `key` where replaced otherwise false is returned.
      */
     put(key: OneOrMore<string>, value: TType, ttl?: TimeSpan | null): LazyPromise<boolean>;
     /**
-     * The <i>update</i> method updates the given <i>key</i> with given <i>value</i>.
+     * The `update` method updates the given `key` with given `value`.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
-     * @returns true if the <i>key</i> where updated otherwise false will be returned.
+     * @returns true if the `key` where updated otherwise false will be returned.
      */
     update(key: OneOrMore<string>, value: TType): LazyPromise<boolean>;
     /**
-     * The <i>increment</i> method increments the given <i>key</i> with given <i>value</i>.
+     * The `increment` method increments the given `key` with given `value`.
      * An error will thrown if the key is not a number.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
      * @param value - If not defined then it will be defaulted to 1.
      *
-     * @returns true if the <i>key</i> where incremented otherwise false will be returned.
+     * @returns true if the `key` where incremented otherwise false will be returned.
      *
      * @throws {TypeCacheError} {@link TypeCacheError}
      */
     increment(key: OneOrMore<string>, value?: Extract<TType, number>): LazyPromise<boolean>;
     /**
-     * The <i>decrement</i> method decrements the given <i>key</i> with given <i>value</i>.
+     * The `decrement` method decrements the given `key` with given `value`.
      * An error will thrown if the key is not a number.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
      * @param value - If not defined then it will be defaulted to 1.
      *
-     * @returns true if the <i>key</i> where decremented otherwise false will be returned.
+     * @returns true if the `key` where decremented otherwise false will be returned.
      *
      * @throws {TypeCacheError} {@link TypeCacheError}
      */
     decrement(key: OneOrMore<string>, value?: Extract<TType, number>): LazyPromise<boolean>;
     /**
-     * The <i>remove</i> method removes the given <i>key</i>.
+     * The `remove` method removes the given `key`.
      *
-     * @param key - can be a string or an <i>Iterable</i> of strings.
-     * If it's an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param key - can be a string or an `Iterable` of strings.
+     * If it's an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
      * @returns true if the key is found otherwise false is returned.
      */
     remove(key: OneOrMore<string>): LazyPromise<boolean>;
     /**
-     * The <i>removeMany</i> method removes many keys.
+     * The `removeMany` method removes many keys.
      *
-     * @param keys - The param items can be a string or an <i>Iterable</i> of strings.
-     * If the param items are an <i>Iterable</i>, it will be joined into a single string.
-     * Think of an <i>Iterable</i> as representing a path.
+     * @param keys - The param items can be a string or an `Iterable` of strings.
+     * If the param items are an `Iterable`, it will be joined into a single string.
+     * Think of an `Iterable` as representing a path.
      *
      * @returns true if one of the keys where deleted otherwise false is returned.
      */
-    removeMany(keys: Iterable<OneOrMore<string>>): PromiseLike<boolean>;
+    removeMany(keys: Iterable<OneOrMore<string>>): LazyPromise<boolean>;
     /**
-     * The <i>clear</i> method removes all the keys in the cache. If a cache is in a group then only the keys part of the group will be removed.
+     * The `clear` method removes all the keys in the cache. If a cache is in a group then only the keys part of the group will be removed.
      */
     clear(): LazyPromise<void>;
 };
 /**
- * The <i>ICache</i> contract defines a way for as key-value pairs independent of data storage and listening to operation events.
+ * The `ICache` contract defines a way for as key-value pairs independent of data storage and listening to operation events.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Contracts
  */
 export type ICache<TType = unknown> = ICacheListenable<TType> & ICacheBase<TType>;

package/dist/cache/contracts/cache.errors.d.ts

@@ -5,7 +5,7 @@ import type { IFlexibleSerde, ISerializable } from "../../serde/contracts/_modul
 import { type ISerializedError, type OneOrMore } from "../../utilities/_module-exports.js";
 /**
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export declare class CacheError extends Error implements ISerializable<ISerializedError> {
@@ -15,7 +15,7 @@ export declare class CacheError extends Error implements ISerializable<ISerializ
 }
 /**
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export declare class UnexpectedCacheError extends CacheError implements ISerializable<ISerializedError> {
@@ -25,7 +25,7 @@ export declare class UnexpectedCacheError extends CacheError implements ISeriali
 /**
  * The error is thrown when attempting to increment or decrement a key that is not of number type.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export declare class TypeCacheError extends CacheError implements ISerializable<ISerializedError> {
@@ -35,7 +35,7 @@ export declare class TypeCacheError extends CacheError implements ISerializable<
 /**
  * The error is thrown when a key is not found
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export declare class KeyNotFoundCacheError extends CacheError implements ISerializable<ISerializedError> {
@@ -44,7 +44,7 @@ export declare class KeyNotFoundCacheError extends CacheError implements ISerial
 }
 /**
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export declare const CACHE_ERRORS: {
@@ -54,9 +54,9 @@ export declare const CACHE_ERRORS: {
     readonly KeyNotFound: typeof KeyNotFoundCacheError;
 };
 /**
- * The <i>registerCacheErrorsToSerde</i> function registers all <i>{@link ICache}</i> related errors with <i>IFlexibleSerde</i>, ensuring they will properly be serialized and deserialized.
+ * The `registerCacheErrorsToSerde` function registers all {@link ICache | `ICache`} related errors with `IFlexibleSerde`, ensuring they will properly be serialized and deserialized.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export declare function registerCacheErrorsToSerde(serde: OneOrMore<IFlexibleSerde>): void;

package/dist/cache/contracts/cache.errors.js

@@ -4,7 +4,7 @@
 import { CORE, resolveOneOrMore, } from "../../utilities/_module-exports.js";
 /**
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export class CacheError extends Error {
@@ -25,7 +25,7 @@ export class CacheError extends Error {
 }
 /**
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export class UnexpectedCacheError extends CacheError {
@@ -40,7 +40,7 @@ export class UnexpectedCacheError extends CacheError {
 /**
  * The error is thrown when attempting to increment or decrement a key that is not of number type.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export class TypeCacheError extends CacheError {
@@ -55,7 +55,7 @@ export class TypeCacheError extends CacheError {
 /**
  * The error is thrown when a key is not found
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export class KeyNotFoundCacheError extends CacheError {
@@ -69,7 +69,7 @@ export class KeyNotFoundCacheError extends CacheError {
 }
 /**
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export const CACHE_ERRORS = {
@@ -79,9 +79,9 @@ export const CACHE_ERRORS = {
     KeyNotFound: KeyNotFoundCacheError,
 };
 /**
- * The <i>registerCacheErrorsToSerde</i> function registers all <i>{@link ICache}</i> related errors with <i>IFlexibleSerde</i>, ensuring they will properly be serialized and deserialized.
+ * The `registerCacheErrorsToSerde` function registers all {@link ICache | `ICache`} related errors with `IFlexibleSerde`, ensuring they will properly be serialized and deserialized.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/contracts"```
+ * IMPORT_PATH: `"@daiso-tech/core/cache/contracts"`
  * @group Errors
  */
 export function registerCacheErrorsToSerde(serde) {