Class InvocationList<T>

Type Parameters

T extends BaseInvocationArgs

Implements

Iterable<Invocation<T> | ErrorInvocation>

Index

Constructors

Accessors

Methods

[iterator] dispatch

Constructors

constructor

new InvocationList<T extends BaseInvocationArgs>(
invocations: (ErrorInvocation | Invocation<T>)[],
logger: ClientContext,
): InvocationList<T>
Type Parameters
- T extends BaseInvocationArgs
Parameters
- invocations: (ErrorInvocation | Invocation<T>)[]
  The list of invocations (or errors) to manage.
- logger: ClientContext
  Optional logger instance for logging within the invocation list.
Returns InvocationList<T>
- Defined in src/invocation-factory/invocation-list.ts:16

Accessors

size

get size(): number
Get the number of invocations and errors in the list.

Returns number
- Defined in src/invocation-factory/invocation-list.ts:31

Methods

[iterator]

"[iterator]"(): ArrayIterator<ErrorInvocation | Invocation<T>>
Returns ArrayIterator<ErrorInvocation | Invocation<T>>
An iterator over the invocations and errors in the list.
Implementation of Iterable.[iterator]
- Defined in src/invocation-factory/invocation-list.ts:24

dispatch

dispatch(
handlers: InvocationHandlerMap,
defaultHandler?: HandlerFn,
): Promise<void>
Dispatch each invocation or error in the list to the appropriate handler function.
Parameters
- handlers: InvocationHandlerMap
  An object mapping method IDs (symbols), method names (e.g., "Mailbox/get"), data types (e.g. "Mailbox"), or the special property error to handler functions. - Each handler receives the invocation of the appropriate type. - The error property, if present, will be called for error invocations.
- OptionaldefaultHandler: HandlerFn
  Optional handler for invocations with no registered handler.
Returns Promise<void>
A promise that resolves when all handlers have been called.
- Defined in src/invocation-factory/invocation-list.ts:60