Class ParallelHook<I, O, E>

Type Parameters

I
O
E

Hierarchy (view full)

Subscribable<HookTap<I, O, E>>
- ParallelHook

Index

Constructors

Properties

Accessors

Methods

execute registerProxy subscribe unregisterProxy unsubscribe

Constructors

constructor

new ParallelHook<I, O, E>(entity): ParallelHook<I, O, E>
Type Parameters
- I
- O
- E
Parameters
- entity: E
Returns ParallelHook<I, O, E>
Overrides Subscribable.constructor
- Defined in events/src/hook.ts:32

Properties

`Protected` `Readonly`entity

entity: E

Accessors

listeners

get listeners(): F[]
Returns F[]
Inherited from Subscribable.listeners
- Defined in events/src/subscribable.ts:12

Methods

execute

execute(data): O[]
Parameters
- data: I
Returns O[]
- Defined in events/src/hook.ts:36

registerProxy

registerProxy(token, getListeners): void
This function is only used internally for proxies
Parameters
- token: any
- getListeners: GetListenersFn<HookTap<I, O, E>>
Returns void
Inherited from Subscribable.registerProxy
- Defined in events/src/subscribable.ts:51

subscribe

subscribe(token, callback): void
Subscribe to the event / hook
Parameters
- token: any
  A token that can be used to unsubscribe from the event / hook later on
- callback: HookTap<I, O, E>
  A callback that will be invoked when the event / hook occurs
Returns void
Inherited from Subscribable.subscribe
- Defined in events/src/subscribable.ts:21

unregisterProxy

unregisterProxy(token): void
This function is only used internally for proxies
Parameters
- token: any
Returns void
Inherited from Subscribable.unregisterProxy
- Defined in events/src/subscribable.ts:65

unsubscribe

unsubscribe(token): void
Remove a listener
Parameters
- token: any
  The token that was specified when subscribing to the listener. An invalid token does not result in an error.
Returns void
Inherited from Subscribable.unsubscribe
- Defined in events/src/subscribable.ts:39