obsidian-dev-utils 32.0.1 → 32.0.2-beta.1

package/dist/lib/esm/Array.mjs

@@ -6,9 +6,10 @@ if you want to view the source, please visit the github repository of this plugi
 (function initEsm(){if(globalThis.process){return}const browserProcess={browser:true,cwd:__name(()=>"/","cwd"),env:{},platform:"android"};globalThis.process=browserProcess})();
 
 function filterInPlace(arr, predicate) {
+  const length = arr.length;
   let writeIndex = 0;
-  for (let readIndex = 0; readIndex < arr.length; readIndex++) {
-    if (!(readIndex in arr)) {
+  for (let readIndex = 0; readIndex < length; readIndex++) {
+    if (!Object.hasOwn(arr, readIndex)) {
       continue;
     }
     const current = arr[readIndex];
@@ -43,4 +44,4 @@ export {
   unique,
   uniqueInPlace
 };
-//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL0FycmF5LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBwYWNrYWdlRG9jdW1lbnRhdGlvblxuICpcbiAqIEFycmF5IHV0aWxpdGllcy5cbiAqL1xuXG4vKipcbiAqIEZpbHRlciBhbiBhcnJheSBpbiBwbGFjZS5cbiAqXG4gKiBAcGFyYW0gYXJyIC0gVGhlIGFycmF5IHRvIGZpbHRlci5cbiAqIEBwYXJhbSBwcmVkaWNhdGUgLSBUaGUgcHJlZGljYXRlIHRvIGZpbHRlciB0aGUgYXJyYXkuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBmaWx0ZXJJblBsYWNlPFQ+KGFycjogVFtdLCBwcmVkaWNhdGU6ICh2YWx1ZTogVCwgaW5kZXg6IG51bWJlciwgYXJyYXk6IFRbXSkgPT4gYm9vbGVhbik6IHZvaWQge1xuICBsZXQgd3JpdGVJbmRleCA9IDA7XG4gIGZvciAobGV0IHJlYWRJbmRleCA9IDA7IHJlYWRJbmRleCA8IGFyci5sZW5ndGg7IHJlYWRJbmRleCsrKSB7XG4gICAgaWYgKCEocmVhZEluZGV4IGluIGFycikpIHtcbiAgICAgIGNvbnRpbnVlO1xuICAgIH1cblxuICAgIGNvbnN0IGN1cnJlbnQgPSBhcnJbcmVhZEluZGV4XSBhcyBUO1xuICAgIGlmIChwcmVkaWNhdGUoY3VycmVudCwgcmVhZEluZGV4LCBhcnIpKSB7XG4gICAgICBhcnJbd3JpdGVJbmRleCsrXSA9IGN1cnJlbnQ7XG4gICAgfVxuICB9XG4gIGFyci5sZW5ndGggPSB3cml0ZUluZGV4O1xufVxuXG4vKipcbiAqIFJlbW92ZSBkdXBsaWNhdGVzIGZyb20gYW4gYXJyYXkuXG4gKlxuICogQHBhcmFtIGFyciAtIFRoZSBhcnJheSB0byByZW1vdmUgZHVwbGljYXRlcyBmcm9tLlxuICogQHJldHVybnMgVGhlIGFycmF5IHdpdGggZHVwbGljYXRlcyByZW1vdmVkLlxuICovXG5leHBvcnQgZnVuY3Rpb24gdW5pcXVlPFQ+KGFycjogcmVhZG9ubHkgVFtdKTogVFtdIHtcbiAgY29uc3Qgc2V0ID0gbmV3IFNldDxUPigpO1xuICByZXR1cm4gYXJyLmZpbHRlcigodmFsdWUpID0+IHtcbiAgICBpZiAoc2V0Lmhhcyh2YWx1ZSkpIHtcbiAgICAgIHJldHVybiBmYWxzZTtcbiAgICB9XG4gICAgc2V0LmFkZCh2YWx1ZSk7XG4gICAgcmV0dXJuIHRydWU7XG4gIH0pO1xufVxuXG4vKipcbiAqIFJlbW92ZSBkdXBsaWNhdGVzIGZyb20gYW4gYXJyYXkgaW4gcGxhY2UuXG4gKlxuICogQHBhcmFtIGFyciAtIFRoZSBhcnJheSB0byByZW1vdmUgZHVwbGljYXRlcyBmcm9tLlxuICovXG5leHBvcnQgZnVuY3Rpb24gdW5pcXVlSW5QbGFjZShhcnI6IHVua25vd25bXSk6IHZvaWQge1xuICBjb25zdCBzZXQgPSBuZXcgU2V0PHVua25vd24+KCk7XG4gIGZpbHRlckluUGxhY2UoYXJyLCAodmFsdWUpID0+IHtcbiAgICBpZiAoc2V0Lmhhcyh2YWx1ZSkpIHtcbiAgICAgIHJldHVybiBmYWxzZTtcbiAgICB9XG4gICAgc2V0LmFkZCh2YWx1ZSk7XG4gICAgcmV0dXJuIHRydWU7XG4gIH0pO1xufVxuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7OztBQVlPLFNBQVMsY0FBaUIsS0FBVSxXQUFtRTtBQUM1RyxNQUFJLGFBQWE7QUFDakIsV0FBUyxZQUFZLEdBQUcsWUFBWSxJQUFJLFFBQVEsYUFBYTtBQUMzRCxRQUFJLEVBQUUsYUFBYSxNQUFNO0FBQ3ZCO0FBQUEsSUFDRjtBQUVBLFVBQU0sVUFBVSxJQUFJLFNBQVM7QUFDN0IsUUFBSSxVQUFVLFNBQVMsV0FBVyxHQUFHLEdBQUc7QUFDdEMsVUFBSSxZQUFZLElBQUk7QUFBQSxJQUN0QjtBQUFBLEVBQ0Y7QUFDQSxNQUFJLFNBQVM7QUFDZjtBQVFPLFNBQVMsT0FBVSxLQUF3QjtBQUNoRCxRQUFNLE1BQU0sb0JBQUksSUFBTztBQUN2QixTQUFPLElBQUksT0FBTyxDQUFDLFVBQVU7QUFDM0IsUUFBSSxJQUFJLElBQUksS0FBSyxHQUFHO0FBQ2xCLGFBQU87QUFBQSxJQUNUO0FBQ0EsUUFBSSxJQUFJLEtBQUs7QUFDYixXQUFPO0FBQUEsRUFDVCxDQUFDO0FBQ0g7QUFPTyxTQUFTLGNBQWMsS0FBc0I7QUFDbEQsUUFBTSxNQUFNLG9CQUFJLElBQWE7QUFDN0IsZ0JBQWMsS0FBSyxDQUFDLFVBQVU7QUFDNUIsUUFBSSxJQUFJLElBQUksS0FBSyxHQUFHO0FBQ2xCLGFBQU87QUFBQSxJQUNUO0FBQ0EsUUFBSSxJQUFJLEtBQUs7QUFDYixXQUFPO0FBQUEsRUFDVCxDQUFDO0FBQ0g7IiwKICAibmFtZXMiOiBbXQp9Cg==
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL0FycmF5LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyIvKipcbiAqIEBwYWNrYWdlRG9jdW1lbnRhdGlvblxuICpcbiAqIEFycmF5IHV0aWxpdGllcy5cbiAqL1xuXG4vKipcbiAqIEZpbHRlciBhbiBhcnJheSBpbiBwbGFjZS5cbiAqXG4gKiBAcGFyYW0gYXJyIC0gVGhlIGFycmF5IHRvIGZpbHRlci5cbiAqIEBwYXJhbSBwcmVkaWNhdGUgLSBUaGUgcHJlZGljYXRlIHRvIGZpbHRlciB0aGUgYXJyYXkuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBmaWx0ZXJJblBsYWNlPFQ+KGFycjogVFtdLCBwcmVkaWNhdGU6ICh2YWx1ZTogVCwgaW5kZXg6IG51bWJlciwgYXJyYXk6IFRbXSkgPT4gYm9vbGVhbik6IHZvaWQge1xuICBjb25zdCBsZW5ndGggPSBhcnIubGVuZ3RoO1xuICBsZXQgd3JpdGVJbmRleCA9IDA7XG4gIGZvciAobGV0IHJlYWRJbmRleCA9IDA7IHJlYWRJbmRleCA8IGxlbmd0aDsgcmVhZEluZGV4KyspIHtcbiAgICBpZiAoIU9iamVjdC5oYXNPd24oYXJyLCByZWFkSW5kZXgpKSB7XG4gICAgICBjb250aW51ZTtcbiAgICB9XG5cbiAgICBjb25zdCBjdXJyZW50ID0gYXJyW3JlYWRJbmRleF0gYXMgVDtcbiAgICBpZiAocHJlZGljYXRlKGN1cnJlbnQsIHJlYWRJbmRleCwgYXJyKSkge1xuICAgICAgYXJyW3dyaXRlSW5kZXgrK10gPSBjdXJyZW50O1xuICAgIH1cbiAgfVxuICBhcnIubGVuZ3RoID0gd3JpdGVJbmRleDtcbn1cblxuLyoqXG4gKiBSZW1vdmUgZHVwbGljYXRlcyBmcm9tIGFuIGFycmF5LlxuICpcbiAqIEBwYXJhbSBhcnIgLSBUaGUgYXJyYXkgdG8gcmVtb3ZlIGR1cGxpY2F0ZXMgZnJvbS5cbiAqIEByZXR1cm5zIFRoZSBhcnJheSB3aXRoIGR1cGxpY2F0ZXMgcmVtb3ZlZC5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHVuaXF1ZTxUPihhcnI6IHJlYWRvbmx5IFRbXSk6IFRbXSB7XG4gIGNvbnN0IHNldCA9IG5ldyBTZXQ8VD4oKTtcbiAgcmV0dXJuIGFyci5maWx0ZXIoKHZhbHVlKSA9PiB7XG4gICAgaWYgKHNldC5oYXModmFsdWUpKSB7XG4gICAgICByZXR1cm4gZmFsc2U7XG4gICAgfVxuICAgIHNldC5hZGQodmFsdWUpO1xuICAgIHJldHVybiB0cnVlO1xuICB9KTtcbn1cblxuLyoqXG4gKiBSZW1vdmUgZHVwbGljYXRlcyBmcm9tIGFuIGFycmF5IGluIHBsYWNlLlxuICpcbiAqIEBwYXJhbSBhcnIgLSBUaGUgYXJyYXkgdG8gcmVtb3ZlIGR1cGxpY2F0ZXMgZnJvbS5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHVuaXF1ZUluUGxhY2UoYXJyOiB1bmtub3duW10pOiB2b2lkIHtcbiAgY29uc3Qgc2V0ID0gbmV3IFNldDx1bmtub3duPigpO1xuICBmaWx0ZXJJblBsYWNlKGFyciwgKHZhbHVlKSA9PiB7XG4gICAgaWYgKHNldC5oYXModmFsdWUpKSB7XG4gICAgICByZXR1cm4gZmFsc2U7XG4gICAgfVxuICAgIHNldC5hZGQodmFsdWUpO1xuICAgIHJldHVybiB0cnVlO1xuICB9KTtcbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7QUFZTyxTQUFTLGNBQWlCLEtBQVUsV0FBbUU7QUFDNUcsUUFBTSxTQUFTLElBQUk7QUFDbkIsTUFBSSxhQUFhO0FBQ2pCLFdBQVMsWUFBWSxHQUFHLFlBQVksUUFBUSxhQUFhO0FBQ3ZELFFBQUksQ0FBQyxPQUFPLE9BQU8sS0FBSyxTQUFTLEdBQUc7QUFDbEM7QUFBQSxJQUNGO0FBRUEsVUFBTSxVQUFVLElBQUksU0FBUztBQUM3QixRQUFJLFVBQVUsU0FBUyxXQUFXLEdBQUcsR0FBRztBQUN0QyxVQUFJLFlBQVksSUFBSTtBQUFBLElBQ3RCO0FBQUEsRUFDRjtBQUNBLE1BQUksU0FBUztBQUNmO0FBUU8sU0FBUyxPQUFVLEtBQXdCO0FBQ2hELFFBQU0sTUFBTSxvQkFBSSxJQUFPO0FBQ3ZCLFNBQU8sSUFBSSxPQUFPLENBQUMsVUFBVTtBQUMzQixRQUFJLElBQUksSUFBSSxLQUFLLEdBQUc7QUFDbEIsYUFBTztBQUFBLElBQ1Q7QUFDQSxRQUFJLElBQUksS0FBSztBQUNiLFdBQU87QUFBQSxFQUNULENBQUM7QUFDSDtBQU9PLFNBQVMsY0FBYyxLQUFzQjtBQUNsRCxRQUFNLE1BQU0sb0JBQUksSUFBYTtBQUM3QixnQkFBYyxLQUFLLENBQUMsVUFBVTtBQUM1QixRQUFJLElBQUksSUFBSSxLQUFLLEdBQUc7QUFDbEIsYUFBTztBQUFBLElBQ1Q7QUFDQSxRQUFJLElBQUksS0FBSztBQUNiLFdBQU87QUFBQSxFQUNULENBQUM7QUFDSDsiLAogICJuYW1lcyI6IFtdCn0K

package/dist/lib/esm/Async.d.mts

@@ -10,10 +10,6 @@ import type { Promisable } from 'type-fest';
  * @typeParam T - The type of the value.
  */
 export type PromiseResolve<T> = undefined extends T ? (value?: PromiseLike<T> | T) => void : (value: PromiseLike<T> | T) => void;
-/**
- * A constant representing an infinite timeout.
- */
-export declare const INFINITE_TIMEOUT: number;
 /**
  * Options for configuring the retry behavior.
  */
@@ -35,22 +31,14 @@ export interface RetryOptions {
      */
     timeoutInMilliseconds?: number;
 }
-/**
- * A marker interface to indicate that an error should terminate retry logic.
- */
-export interface TerminateRetry {
-    /**
-     * A marker property to indicate that an error should terminate retry logic.
-     */
-    __terminateRetry: true;
-}
 /**
  * Adds an error handler to a {@link Promise} that catches any errors and emits an async error event.
  *
  * @param asyncFn - The asynchronous function to add an error handler to.
+ * @param stackTrace - The stack trace of the source function.
  * @returns A {@link Promise} that resolves when the asynchronous function completes or emits async error event.
  */
-export declare function addErrorHandler(asyncFn: () => Promise<unknown>): Promise<void>;
+export declare function addErrorHandler(asyncFn: () => Promise<unknown>, stackTrace?: string): Promise<void>;
 /**
  * Filters an array asynchronously, keeping only the elements that satisfy the provided predicate function.
  *
@@ -60,6 +48,15 @@ export declare function addErrorHandler(asyncFn: () => Promise<unknown>): Promis
  * @returns A {@link Promise} that resolves with an array of elements that satisfy the predicate function.
  */
 export declare function asyncFilter<T>(arr: T[], predicate: (value: T, index: number, array: T[]) => Promisable<boolean>): Promise<T[]>;
+/**
+ * Filters an array asynchronously in place, keeping only the elements that satisfy the provided predicate function.
+ *
+ * @typeParam T - The type of elements in the input array.
+ * @param arr - The array to filter.
+ * @param predicate - The predicate function to test each element.
+ * @returns A {@link Promise} that resolves when the array is filtered.
+ */
+export declare function asyncFilterInPlace<T>(arr: T[], predicate: (value: T, index: number, array: T[]) => Promisable<boolean>): Promise<void>;
 /**
  * Maps over an array asynchronously, applying the provided callback function to each element, and then flattens the results into a single array.
  *
@@ -85,9 +82,10 @@ export declare function asyncMap<T, U>(arr: T[], callback: (value: T, index: num
  *
  * @typeParam Args - The types of the arguments the function accepts.
  * @param asyncFunc - The asynchronous function to convert.
+ * @param stackTrace - The stack trace of the source function.
  * @returns A function that wraps the asynchronous function in a synchronous interface.
  */
-export declare function convertAsyncToSync<Args extends unknown[]>(asyncFunc: (...args: Args) => Promise<unknown>): (...args: Args) => void;
+export declare function convertAsyncToSync<Args extends unknown[]>(asyncFunc: (...args: Args) => Promise<unknown>, stackTrace?: string): (...args: Args) => void;
 /**
  * Converts a synchronous function to an asynchronous one by wrapping it in a {@link Promise}.
  *
@@ -109,22 +107,58 @@ export declare function ignoreError(promise: Promise<unknown>, fallbackValue?: u
  * Invokes a {@link Promise} and safely handles any errors by catching them and emitting an async error event.
  *
  * @param asyncFn - The asynchronous function to invoke safely.
+ * @param stackTrace - The stack trace of the source function.
  */
-export declare function invokeAsyncSafely(asyncFn: () => Promise<unknown>): void;
+export declare function invokeAsyncSafely(asyncFn: () => Promise<unknown>, stackTrace?: string): void;
 /**
  * Invokes an asynchronous function after a delay.
  *
  * @param asyncFn - The asynchronous function to invoke.
  * @param delayInMilliseconds - The delay in milliseconds.
+ * @param stackTrace - The stack trace of the source function.
+ * @param abortSignal - The abort signal to listen to.
+ */
+export declare function invokeAsyncSafelyAfterDelay(asyncFn: (abortSignal: AbortSignal) => Promisable<void>, delayInMilliseconds?: number, stackTrace?: string, abortSignal?: AbortSignal): void;
+/**
+ * Executes async functions sequentially.
+ *
+ * @typeParam T - The type of the value.
+ * @param asyncFns - The async functions to execute sequentially.
+ * @returns A {@link Promise} that resolves with an array of the results of the async functions.
  */
-export declare function invokeAsyncSafelyAfterDelay(asyncFn: () => Promisable<unknown>, delayInMilliseconds?: number): void;
+export declare function promiseAllAsyncFnsSequentially<T>(asyncFns: (() => Promisable<T>)[]): Promise<T[]>;
+/**
+ * Executes promises sequentially.
+ *
+ * @typeParam T - The type of the value.
+ * @param promises - The promises to execute sequentially.
+ * @returns A {@link Promise} that resolves with an array of the results of the promises.
+ */
+export declare function promiseAllSequentially<T>(promises: Promisable<T>[]): Promise<T[]>;
 /**
  * Marks an error to terminate retry logic.
  *
  * @param error - The error to mark to terminate retry logic.
- * @returns An error that should terminate retry logic.
  */
-export declare function marksAsTerminateRetry<TError extends Error>(error: TError): TerminateRetry & TError;
+export declare function marksAsTerminateRetry(error: Error): void;
+/**
+ * An async function that never ends.
+ *
+ * @returns A {@link Promise} that never resolves.
+ */
+export declare function neverEnds(): Promise<never>;
+/**
+ * Gets the next tick.
+ *
+ * @returns A promise that resolves when the next tick is available.
+ */
+export declare function nextTickAsync(): Promise<void>;
+/**
+ * Gets the next queue microtask.
+ *
+ * @returns A promise that resolves when the next queue microtask is available.
+ */
+export declare function queueMicrotaskAsync(): Promise<void>;
 /**
  * Gets the next request animation frame.
  *
@@ -149,30 +183,41 @@ export declare function retryWithTimeout(fn: (abortSignal: AbortSignal) => Promi
  * @param timeoutInMilliseconds - The maximum time to wait in milliseconds.
  * @param fn - The function to execute.
  * @param context - The context of the function.
+ * @param stackTrace - The stack trace of the source function.
  * @returns A {@link Promise} that resolves with the result of the asynchronous function or rejects if it times out.
  */
-export declare function runWithTimeout<R>(timeoutInMilliseconds: number, fn: (abortSignal: AbortSignal) => Promisable<R>, context?: unknown): Promise<R>;
+export declare function runWithTimeout<R>(timeoutInMilliseconds: number, fn: (abortSignal: AbortSignal) => Promisable<R>, context?: unknown, stackTrace?: string): Promise<R>;
+/**
+ * Gets the next set immediate.
+ *
+ * @returns A promise that resolves when the next set immediate is available.
+ */
+export declare function setImmediateAsync(): Promise<void>;
 /**
  * Delays execution for a specified number of milliseconds.
  *
- * @param milliseconds - The time to wait in milliseconds.
+ * @param delay - The time to wait in milliseconds.
  * @returns A {@link Promise} that resolves after the specified delay.
  */
-export declare function sleep(milliseconds: number): Promise<void>;
+export declare function setTimeoutAsync(delay?: number): Promise<void>;
 /**
- * Returns a {@link Promise} that rejects when the abort signal is aborted.
+ * Delays execution for a specified number of milliseconds.
  *
+ * @param milliseconds - The time to wait in milliseconds.
  * @param abortSignal - The abort signal to listen to.
- * @returns A {@link Promise} that rejects when the abort signal is aborted.
+ * @param shouldThrowOnAbort - Whether to throw an error if the abort signal is aborted.
+ * @returns A {@link Promise} that resolves after the specified delay.
  */
-export declare function throwOnAbort(abortSignal: AbortSignal): Promise<void>;
+export declare function sleep(milliseconds: number, abortSignal?: AbortSignal, shouldThrowOnAbort?: boolean): Promise<void>;
 /**
  * Returns a {@link Promise} that rejects after the specified timeout period.
  *
  * @param timeoutInMilliseconds - The timeout period in milliseconds.
+ * @param abortSignal - The abort signal to listen to.
+ * @param shouldThrowOnAbort - Whether to throw an error if the abort signal is aborted.
  * @returns A {@link Promise} that always rejects with a timeout error.
  */
-export declare function timeout(timeoutInMilliseconds: number): Promise<never>;
+export declare function timeout(timeoutInMilliseconds: number, abortSignal?: AbortSignal, shouldThrowOnAbort?: boolean): Promise<never>;
 /**
  * Converts an AsyncIterableIterator to an array by consuming all its elements.
  *