Class StateTracker<T>

Type Parameters

T

Hierarchy

StateTracker

Index

Constructors

Properties

_ee _state _subscriptions _uuid

Accessors

Methods

await set subscribe unsubscribe

Constructors

constructor

new StateTracker<T>(initialStatus: T, eventEmitter?: EventEmitter): StateTracker<T>
Type Parameters
- T
Parameters
- initialStatus: T
- Optional eventEmitter: EventEmitter
Returns StateTracker<T>
- Defined in moirae/core/lib/classes/state-tracker.class.ts:14

Properties

`Private` `Readonly` _ee

_ee: EventEmitter

`Private` _state

_state: T

`Private` `Readonly` _subscriptions

_subscriptions: Map<string, SubscriptionFunction<T>>

`Private` `Readonly` _uuid

_uuid: string

Accessors

`Private` _key

get _key(): string
Returns string
- Defined in moirae/core/lib/classes/state-tracker.class.ts:22

current

get current(): T
Get the current state

Returns T
- Defined in moirae/core/lib/classes/state-tracker.class.ts:29

Methods

await

await(desiredState: T): Promise<T>
Parameters
- desiredState: T
Returns Promise<T>
- Defined in moirae/core/lib/classes/state-tracker.class.ts:33

set

set(newState: T): void
Parameters
- newState: T
Returns void
- Defined in moirae/core/lib/classes/state-tracker.class.ts:49

subscribe

subscribe(handler: SubscriptionFunction<T>): string
Subscribe to all updates to the state
Parameters
- handler: SubscriptionFunction<T>
Returns string
- Defined in moirae/core/lib/classes/state-tracker.class.ts:57

unsubscribe

unsubscribe(key: string): void
Unsubscribe from updates to the state
Parameters
- key: string
Returns void
- Defined in moirae/core/lib/classes/state-tracker.class.ts:67

Generated using TypeDoc