Class Distributor<TPayload>

Provides a distribution method to publish payloads to multiple subscribers

Type Parameters

TPayload

Hierarchy

Distributor

Index

Constructors

Properties

_ee _subscriptions _uuid

Accessors

_key listenerCount

Methods

clear publish subscribe unsubscribe

Constructors

constructor

new Distributor<TPayload>(eventEmitter: EventEmitter, _uuid: string): Distributor<TPayload>
Type Parameters
- TPayload
Parameters
- eventEmitter: EventEmitter
- _uuid: string
Returns Distributor<TPayload>
- Defined in moirae/core/lib/classes/distributor.class.ts:13

Properties

`Private` `Readonly` _ee

_ee: EventEmitter

`Private` `Readonly` _subscriptions

_subscriptions: Map<string, ((event: TPayload) => void)>

`Private` `Readonly` _uuid

_uuid: string

Accessors

`Protected` _key

get _key(): string
Returns string
- Defined in moirae/core/lib/classes/distributor.class.ts:18

listenerCount

get listenerCount(): number
Returns number
- Defined in moirae/core/lib/classes/distributor.class.ts:22

Methods

clear

clear(): void
Clear all existing subscriptions

Returns void
- Defined in moirae/core/lib/classes/distributor.class.ts:29

publish

publish(event: TPayload): Promise<void>
Publish a payload to the distributor
Parameters
- event: TPayload
Returns Promise<void>
- Defined in moirae/core/lib/classes/distributor.class.ts:46

subscribe

subscribe(handlerFn: ((event: TPayload) => void)): string
Subscribe to the distributor and receive all payloads asynchronously
Parameters
- handlerFn: ((event: TPayload) => void)
  - - (event: TPayload): void
    - Parameters
      
      event: TPayload
      
      Returns void
Returns string
- Defined in moirae/core/lib/classes/distributor.class.ts:36

unsubscribe

unsubscribe(key: string): void
Unsubscribe to all future payloads
Parameters
- key: string
Returns void
- Defined in moirae/core/lib/classes/distributor.class.ts:53

Generated using TypeDoc