Interface IWaitable<T, R>

Interface representing an object that can be waited on.

interface IWaitable<T extends unknown[] = never[], R = void> {
wait(...args: [...T[], signal?: null | AbortSignal]): Promisable<R>;
}

Type Parameters

T extends unknown[] = never[]
Tuple type representing the arguments that can be passed to the wait method.
R = void
Type of the result returned by the wait method.

Implemented by

Index

Methods

Methods

wait

wait(...args: [...T[], signal?: null | AbortSignal]): Promisable<R>
Waits for an event to occur, optionally aborting the wait if the provided AbortSignal is triggered.
Parameters
- ...args: [...T[], signal?: null | AbortSignal]
  Arguments to pass to the wait operation. The last argument can be an optional AbortSignal to cancel the wait operation.
Returns Promisable<R>
A promise that resolves when the event occurs, or rejects if the operation is aborted.
- Defined in packages/misc-util/src/async/iwaitable.ts:19