Class CollectorArray<THandler>

Returns the result of the all signal handlers from a signal emission in an array.

Typeparam

THandler The function signature to be implemented by handlers.

Type Parameters

THandler extends ((...args: any[]) => any)

Hierarchy

Collector<THandler>
- CollectorArray

Index

Constructors

Properties

Methods

getResult handleResult reset

Constructors

constructor

new CollectorArray<THandler>(signal: Signal<THandler>): CollectorArray<THandler>
Create a new collector.
Type Parameters
- THandler extends ((...args: any[]) => any)
Parameters
- signal: Signal<THandler>
  
  The signal to emit.
Returns CollectorArray<THandler>
Inherited from Collector.constructor
- Defined in Collector.ts:21

Properties

`Readonly` emit

emit: ((...args: Parameters<THandler>) => void)

Type declaration

- (...args: Parameters<THandler>): void
- Publish the bound signal event (call all handlers) to start the collection process.
  
  Method
  Parameters
  - Rest ...args: Parameters<THandler>
  Returns void

Methods

getResult

getResult(): ReturnType<THandler>[]
Get the list of results from the signal handlers.

Returns ReturnType<THandler>[]
- Defined in CollectorArray.ts:19

handleResult

handleResult(result: ReturnType<THandler>): boolean
Process the results of a handler invocation.
Parameters
- result: ReturnType<THandler>
  
  true to continue processing handlers.
Returns boolean
Overrides Collector.handleResult
- Defined in CollectorArray.ts:11

reset

reset(): void
Reset the result

Returns void
- Defined in CollectorArray.ts:26

Generated using TypeDoc