Class Hook<T>

Type parameters

T

Hierarchy

Hook

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Hook(name: string): Hook

- Defined in src/Utils/Hookable.ts:78
Parameters
- name: string
Returns Hook

Properties

allowConcurrentNotifications

allowConcurrentNotifications: boolean = false

name

name: string

Protected notificationSemaphore

notificationSemaphore: Semaphore = new Semaphore( 1 )

Protected subscriptions

subscriptions: HookSubscription<T>[] = []

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterator<T, any, undefined>

- Defined in src/Utils/Hookable.ts:159
Returns AsyncIterator<T, any, undefined>

isSubscribed

isSubscribed(): boolean

- Defined in src/Utils/Hookable.ts:108
Returns boolean

notify

notify(arg?: T): Promise<void>

- Defined in src/Utils/Hookable.ts:112
Parameters
- Optional arg: T
Returns Promise<void>

setParallel

setParallel(): this

- Defined in src/Utils/Hookable.ts:90
Returns this

setSequential

setSequential(): this

- Defined in src/Utils/Hookable.ts:84
Returns this

subscribe

subscribe(callback: HookSubscription<T>): HookSubscriptionCancellation

- Defined in src/Utils/Hookable.ts:96
Parameters
- callback: HookSubscription<T>
Returns HookSubscriptionCancellation

toAsyncStream

toAsyncStream(errorHook?: Hook<unknown>, endHook?: Hook<unknown>): AsyncStream<T>

- Defined in src/Utils/Hookable.ts:155
Parameters
- Optional errorHook: Hook<unknown>
- Optional endHook: Hook<unknown>
Returns AsyncStream<T>

toPromise

toPromise(errorHook?: Hook<unknown>): Promise<T>

- Defined in src/Utils/Hookable.ts:132
Parameters
- Optional errorHook: Hook<unknown>
Returns Promise<T>

unsubscribe

unsubscribe(callback: HookSubscription<T>): void

- Defined in src/Utils/Hookable.ts:104
Parameters
- callback: HookSubscription<T>
Returns void

Generated using TypeDoc