ValueDispatcher

class ValueDispatcherT extends EventDispatcherBaseT

Filters

• Protected members
• Inherited members

Dispatches a SubscribableValueEvent

Changing the value stored by a value dispatcher will immediately notify all its subscribers.

Examples

Type Parameters

• T

  The type of the value passed to subscribers.

Constructors

constructor

public override new ValueDispatcherTvalue: T: ValueDispatcherT

Type Parameters

• T

Parameters

• value: T

  The initial value.

Overwrites EventDispatcherBase.constructor

Properties

subscribable

readonly public subscribable: SubscribableValueEventT = ...

Accessors

current

public set currentvalue: T: void

public get current(): T

Set the current value of this dispatcher.

Setting the value will immediately notify all subscribers.

Parameters

• value: T

  The new value.

Methods

clear

public clear(): void

Unsubscribe all subscribers from the event.

Inherited from EventDispatcherBase.clear

---

subscribe

public override subscribehandler: EventHandlerTdispatchImmediately: boolean = true: () => void

Subscribe to the event.

Subscribing will immediately invoke the handler with the most recent value.

Parameters

• handler: EventHandlerT

  The handler to invoke when the event occurs.

• dispatchImmediately: boolean = true

  Whether the handler should be immediately invoked with the most recent value.

Overwrites EventDispatcherBase.subscribe

---

unsubscribe

public unsubscribehandler: EventHandlerT: void

Unsubscribe from the event.

Parameters

• handler: EventHandlerT

  The handler to unsubscribe.

Inherited from EventDispatcherBase.unsubscribe