obsidian-dev-utils 88.8.0 → 89.0.0

package/dist/lib/cjs/async-events.d.cts

@@ -29,7 +29,7 @@ export interface AsyncEventRef {
     /**
      * A context passed as `this` to the `callback`.
      */
-    thisArg: unknown;
+    thisArgument: unknown;
 }
 /**
  * Async event emitter implementation.
@@ -65,7 +65,7 @@ export interface AsyncEventSource<EventMap extends EventMapConstraint<EventMap>
      * Remove an event listener.
      *
      * @typeParam EventName - The name of the event.
-     * @typeParam Args - The arguments of the event.
+     * @typeParam Arguments - The arguments of the event.
      * @param name - The name of the event.
      * @param callback - The callback to remove.
      *
@@ -74,15 +74,15 @@ export interface AsyncEventSource<EventMap extends EventMapConstraint<EventMap>
      * events.off('my-event', myListener);
      * ```
      */
-    off<EventName extends StringKeys<EventMap>, Args extends CallbackArgs<EventMap, EventName>>(name: EventName, callback: (...args: Args) => Promisable<void>): void;
+    off<EventName extends StringKeys<EventMap>, Arguments extends CallbackArguments<EventMap, EventName>>(name: EventName, callback: (...$arguments: Arguments) => Promisable<void>): void;
     /**
      * Add an event listener.
      *
      * @typeParam EventName - The name of the event.
-     * @typeParam Args - The arguments of the event.
+     * @typeParam Arguments - The arguments of the event.
      * @param name - The name of the event.
      * @param callback - The callback to call when the event is triggered.
-     * @param thisArg - The context passed as `this` to the `callback`.
+     * @param thisArgument - The context passed as `this` to the `callback`.
      * @returns A reference to the event listener.
      *
      * @remarks Not refactored to parameter-object pattern, to keep the parity with {@link obsidian#Events#on} (or once, correspondingly).
@@ -95,14 +95,14 @@ export interface AsyncEventSource<EventMap extends EventMapConstraint<EventMap>
      * });
      * ```
      */
-    on<EventName extends StringKeys<EventMap>, Args extends CallbackArgs<EventMap, EventName>>(name: EventName, callback: (...args: Args) => Promisable<void>, thisArg?: unknown): AsyncEventRef;
+    on<EventName extends StringKeys<EventMap>, Arguments extends CallbackArguments<EventMap, EventName>>(name: EventName, callback: (...$arguments: Arguments) => Promisable<void>, thisArgument?: unknown): AsyncEventRef;
     /**
      * Add an event listener that will be triggered only once.
      *
      * @typeParam EventName - The name of the event.
      * @param name - The name of the event.
      * @param callback - The callback to call when the event is triggered.
-     * @param thisArg - The context passed as `this` to the `callback`.
+     * @param thisArgument - The context passed as `this` to the `callback`.
      * @returns A reference to the event listener.
      *
      * @remarks Not refactored to parameter-object pattern, to keep the parity with {@link obsidian#Events#on} (or once, correspondingly).
@@ -115,7 +115,7 @@ export interface AsyncEventSource<EventMap extends EventMapConstraint<EventMap>
      * });
      * ```
      */
-    once<EventName extends StringKeys<EventMap>, Args extends CallbackArgs<EventMap, EventName>>(name: EventName, callback: (...args: Args) => Promisable<void>, thisArg?: unknown): AsyncEventRef;
+    once<EventName extends StringKeys<EventMap>, Arguments extends CallbackArguments<EventMap, EventName>>(name: EventName, callback: (...$arguments: Arguments) => Promisable<void>, thisArgument?: unknown): AsyncEventRef;
 }
 /**
  * Interface exposing event-triggering methods for subclasses of mixin-created classes.
@@ -131,35 +131,35 @@ export interface AsyncEventTrigger<EventMap extends EventMapConstraint<EventMap>
      *
      * @typeParam EventName - The name of the event.
      * @param name - The name of the event.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      */
-    trigger<EventName extends StringKeys<EventMap>>(name: EventName, ...args: CallbackArgs<EventMap, EventName>): void;
+    trigger<EventName extends StringKeys<EventMap>>(name: EventName, ...$arguments: CallbackArguments<EventMap, EventName>): void;
     /**
      * Trigger an event asynchronously.
      *
      * @typeParam EventName - The name of the event.
      * @param name - The name of the event.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      * @returns A {@link Promise} that resolves when all listeners have completed.
      */
-    triggerAsync<EventName extends StringKeys<EventMap>>(name: EventName, ...args: CallbackArgs<EventMap, EventName>): Promise<void>;
+    triggerAsync<EventName extends StringKeys<EventMap>>(name: EventName, ...$arguments: CallbackArguments<EventMap, EventName>): Promise<void>;
     /**
      * Try to trigger an event, executing all the listeners in order even if some of them throw an error.
      *
-     * @typeParam Args - The types of the arguments the function accepts.
+     * @typeParam Arguments - The types of the arguments the function accepts.
      * @param eventRef - The event reference.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      */
-    tryTrigger<Args extends unknown[]>(eventRef: AsyncEventRef, args: Args): void;
+    tryTrigger<Arguments extends unknown[]>(eventRef: AsyncEventRef, $arguments: Arguments): void;
     /**
      * Try to trigger an event asynchronously.
      *
-     * @typeParam Args - The types of the arguments the function accepts.
+     * @typeParam Arguments - The types of the arguments the function accepts.
      * @param eventRef - The event reference.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      * @returns A {@link Promise} that resolves when all listeners have completed.
      */
-    tryTriggerAsync<Args extends unknown[]>(eventRef: AsyncEventRef, args: Args): Promise<void>;
+    tryTriggerAsync<Arguments extends unknown[]>(eventRef: AsyncEventRef, $arguments: Arguments): Promise<void>;
 }
 /**
  * Resolves callback argument types for an event.
@@ -172,7 +172,7 @@ export interface AsyncEventTrigger<EventMap extends EventMapConstraint<EventMap>
  * @typeParam EventMap - Maps event names to their argument tuples.
  * @typeParam EventName - The name of the event.
  */
-export type CallbackArgs<EventMap, EventName extends string> = string extends keyof EventMap ? unknown[] : (EventName extends keyof EventMap ? EventMap[EventName] : unknown[]);
+export type CallbackArguments<EventMap, EventName extends string> = string extends keyof EventMap ? unknown[] : (EventName extends keyof EventMap ? EventMap[EventName] : unknown[]);
 /**
  * Base event map type for untyped emitters.
  */
@@ -211,9 +211,9 @@ export interface SubscribeAsyncDisposableEventParams<Source extends GenericAsync
     /**
      * The context passed as `this` to the callback.
      */
-    readonly thisArg?: unknown;
+    readonly thisArgument?: unknown;
 }
-type AsyncEventCallbackOf<Source extends GenericAsyncEventSource, EventName extends AsyncEventNameOf<Source>> = EventMapOf<Source>[EventName] extends infer Args extends unknown[] ? (...args: Args) => Promisable<void> : never;
+type AsyncEventCallbackOf<Source extends GenericAsyncEventSource, EventName extends AsyncEventNameOf<Source>> = EventMapOf<Source>[EventName] extends infer Arguments extends unknown[] ? (...$arguments: Arguments) => Promisable<void> : never;
 type AsyncEventNameOf<Source extends GenericAsyncEventSource> = keyof EventMapOf<Source> & string;
 type EventMapConstraint<T> = Record<keyof T, unknown[]>;
 type EventMapOf<Source> = Source extends AsyncEventSource<infer EventMap> ? EventMap : never;
@@ -263,12 +263,12 @@ export declare abstract class AsyncEventsBase<EventMap extends EventMapConstrain
     /**
      * The registry mapping each event name to its list of registered listener references.
      */
-    protected readonly eventRefsMap: Map<string, AsyncEventRef[]>;
+    protected readonly eventReferencesMap: Map<string, AsyncEventRef[]>;
     /**
      * Remove an event listener.
      *
      * @typeParam EventName - The name of the event.
-     * @typeParam Args - The types of the arguments the event callback accepts.
+     * @typeParam Arguments - The types of the arguments the event callback accepts.
      * @param name - The name of the event.
      * @param callback - The callback to remove.
      *
@@ -277,7 +277,7 @@ export declare abstract class AsyncEventsBase<EventMap extends EventMapConstrain
      * events.off('my-event', myListener);
      * ```
      */
-    off<EventName extends StringKeys<EventMap>, Args extends CallbackArgs<EventMap, EventName>>(name: EventName, callback: (...args: Args) => Promisable<void>): void;
+    off<EventName extends StringKeys<EventMap>, Arguments extends CallbackArguments<EventMap, EventName>>(name: EventName, callback: (...$arguments: Arguments) => Promisable<void>): void;
     /**
      * Remove an event listener by reference.
      *
@@ -293,10 +293,10 @@ export declare abstract class AsyncEventsBase<EventMap extends EventMapConstrain
      * Add an event listener.
      *
      * @typeParam EventName - The name of the event.
-     * @typeParam Args - The types of the arguments the event callback accepts.
+     * @typeParam Arguments - The types of the arguments the event callback accepts.
      * @param name - The name of the event.
      * @param callback - The callback to call when the event is triggered.
-     * @param thisArg - The context passed as `this` to the `callback`.
+     * @param thisArgument - The context passed as `this` to the `callback`.
      * @returns A reference to the event listener.
      *
      * @remarks Not refactored to parameter-object pattern, to keep the parity with {@link obsidian#Events#on} (or once, correspondingly).
@@ -309,15 +309,15 @@ export declare abstract class AsyncEventsBase<EventMap extends EventMapConstrain
      * });
      * ```
      */
-    on<EventName extends StringKeys<EventMap>, Args extends CallbackArgs<EventMap, EventName>>(name: EventName, callback: (...args: Args) => Promisable<void>, thisArg?: unknown): AsyncEventRef;
+    on<EventName extends StringKeys<EventMap>, Arguments extends CallbackArguments<EventMap, EventName>>(name: EventName, callback: (...$arguments: Arguments) => Promisable<void>, thisArgument?: unknown): AsyncEventRef;
     /**
      * Add an event listener that will be triggered only once.
      *
      * @typeParam EventName - The name of the event.
-     * @typeParam Args - The types of the arguments the event callback accepts.
+     * @typeParam Arguments - The types of the arguments the event callback accepts.
      * @param name - The name of the event.
      * @param callback - The callback to call when the event is triggered.
-     * @param thisArg - The context passed as `this` to the `callback`.
+     * @param thisArgument - The context passed as `this` to the `callback`.
      * @returns A reference to the event listener.
      *
      * @remarks Not refactored to parameter-object pattern, to keep the parity with {@link obsidian#Events#on} (or once, correspondingly).
@@ -330,51 +330,51 @@ export declare abstract class AsyncEventsBase<EventMap extends EventMapConstrain
      * });
      * ```
      */
-    once<EventName extends StringKeys<EventMap>, Args extends CallbackArgs<EventMap, EventName>>(name: EventName, callback: (...args: Args) => Promisable<void>, thisArg?: unknown): AsyncEventRef;
+    once<EventName extends StringKeys<EventMap>, Arguments extends CallbackArguments<EventMap, EventName>>(name: EventName, callback: (...$arguments: Arguments) => Promisable<void>, thisArgument?: unknown): AsyncEventRef;
     /**
      * Trigger an event, executing all the listeners in order even if some of them throw an error.
      *
      * @typeParam EventName - The name of the event.
      * @param name - The name of the event.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      *
      * @example
      * ```ts
      * events.trigger('my-event', 'arg1', 'arg2');
      * ```
      */
-    protected trigger<EventName extends StringKeys<EventMap>>(name: EventName, ...args: CallbackArgs<EventMap, EventName>): void;
+    protected trigger<EventName extends StringKeys<EventMap>>(name: EventName, ...$arguments: CallbackArguments<EventMap, EventName>): void;
     /**
      * Trigger an event asynchronously, executing all the listeners in order even if some of them throw an error.
      *
      * @typeParam EventName - The name of the event.
      * @param name - The name of the event.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      * @returns A {@link Promise} that resolves when all listeners have completed.
      */
-    protected triggerAsync<EventName extends StringKeys<EventMap>>(name: EventName, ...args: CallbackArgs<EventMap, EventName>): Promise<void>;
+    protected triggerAsync<EventName extends StringKeys<EventMap>>(name: EventName, ...$arguments: CallbackArguments<EventMap, EventName>): Promise<void>;
     /**
      * Try to trigger an event, executing all the listeners in order even if some of them throw an error.
      *
-     * @typeParam Args - The types of the arguments the function accepts.
+     * @typeParam Arguments - The types of the arguments the function accepts.
      * @param eventRef - The event reference.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      *
      * @example
      * ```ts
      * events.tryTrigger(myRef, ['arg1', 'arg2']);
      * ```
      */
-    protected tryTrigger<Args extends unknown[]>(eventRef: AsyncEventRef, args: Args): void;
+    protected tryTrigger<Arguments extends unknown[]>(eventRef: AsyncEventRef, $arguments: Arguments): void;
     /**
      * Try to trigger an event asynchronously, executing all the listeners in order even if some of them throw an error.
      *
-     * @typeParam Args - The types of the arguments the function accepts.
+     * @typeParam Arguments - The types of the arguments the function accepts.
      * @param eventRef - The event reference.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      * @returns A {@link Promise} that resolves when all listeners have completed.
      */
-    protected tryTriggerAsync<Args extends unknown[]>(eventRef: AsyncEventRef, args: Args): Promise<void>;
+    protected tryTriggerAsync<Arguments extends unknown[]>(eventRef: AsyncEventRef, $arguments: Arguments): Promise<void>;
 }
 /**
  * A class that extends {@link AsyncEventsBase} and provides public methods for triggering events.
@@ -391,35 +391,35 @@ export declare class AsyncEvents<EventMap extends EventMapConstraint<EventMap> =
      *
      * @typeParam EventName - The name of the event.
      * @param name - The name of the event.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      */
-    trigger<EventName extends StringKeys<EventMap>>(name: EventName, ...args: CallbackArgs<EventMap, EventName>): void;
+    trigger<EventName extends StringKeys<EventMap>>(name: EventName, ...$arguments: CallbackArguments<EventMap, EventName>): void;
     /**
      * Trigger an event asynchronously, executing all the listeners in order even if some of them throw an error.
      *
      * @typeParam EventName - The name of the event.
      * @param name - The name of the event.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      * @returns A {@link Promise} that resolves when all listeners have completed.
      */
-    triggerAsync<EventName extends StringKeys<EventMap>>(name: EventName, ...args: CallbackArgs<EventMap, EventName>): Promise<void>;
+    triggerAsync<EventName extends StringKeys<EventMap>>(name: EventName, ...$arguments: CallbackArguments<EventMap, EventName>): Promise<void>;
     /**
      * Try to trigger an event, executing all the listeners in order even if some of them throw an error.
      *
-     * @typeParam Args - The types of the arguments the function accepts.
+     * @typeParam Arguments - The types of the arguments the function accepts.
      * @param eventRef - The event reference.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      */
-    tryTrigger<Args extends unknown[]>(eventRef: AsyncEventRef, args: Args): void;
+    tryTrigger<Arguments extends unknown[]>(eventRef: AsyncEventRef, $arguments: Arguments): void;
     /**
      * Try to trigger an event asynchronously, executing all the listeners in order even if some of them throw an error.
      *
-     * @typeParam Args - The types of the arguments the function accepts.
+     * @typeParam Arguments - The types of the arguments the function accepts.
      * @param eventRef - The event reference.
-     * @param args - The data to pass to the event listeners.
+     * @param $arguments - The data to pass to the event listeners.
      * @returns A {@link Promise} that resolves when all listeners have completed.
      */
-    tryTriggerAsync<Args extends unknown[]>(eventRef: AsyncEventRef, args: Args): Promise<void>;
+    tryTriggerAsync<Arguments extends unknown[]>(eventRef: AsyncEventRef, $arguments: Arguments): Promise<void>;
 }
 /**
  * Mixin that adds {@link AsyncEventSource} delegation to a base class.