@revideo/core / events / SubscribableValueEvent
Class: SubscribableValueEvent<T>
Defined in: events/ValueDispatcher.ts:82
Provides safe access to the public interface of ValueDispatcher.
Remarks
External classes can use it to subscribe to an event without being able to dispatch it.
Extends
Subscribable<T,EventHandler<T>>
Type Parameters
T
T
The type of the value passed to subscribers.
Constructors
Constructor
new SubscribableValueEvent<
T>(dispatcher):SubscribableValueEvent<T>
Defined in: events/EventDispatcherBase.ts:61
Parameters
dispatcher
EventDispatcherBase<T, EventHandler<T>>
Returns
SubscribableValueEvent<T>
Inherited from
Properties
dispatcher
protecteddispatcher:EventDispatcherBase<T,EventHandler<T>>
Defined in: events/EventDispatcherBase.ts:62
Inherited from
Accessors
current
Get Signature
get current():
T
Defined in: events/ValueDispatcher.ts:89
Get the most recent value of this dispatcher.
Returns
T
Methods
subscribe()
subscribe(
handler,dispatchImmediately?): () =>void
Defined in: events/ValueDispatcher.ts:104
Subscribe to the event.
Subscribing will immediately invoke the handler with the most recent value.
Parameters
handler
EventHandler<T>
The handler to invoke when the event occurs.
dispatchImmediately?
boolean = true
Whether the handler should be immediately invoked with the most recent value.
Returns
Callback function that cancels the subscription.
() => void
Overrides
unsubscribe()
unsubscribe(
handler):void
Defined in: events/EventDispatcherBase.ts:81
Unsubscribe from the event.
Parameters
handler
The handler to unsubscribe.
Returns
void