@revideo/core

@revideo/core / events / EventDispatcherBase

Abstract Class: EventDispatcherBase<TValue, THandler>

Defined in: events/EventDispatcherBase.ts:11 

A base for dispatching Subscribables.

Extended by

• AsyncEventDispatcher
• EventDispatcher
• FlagDispatcher
• ValueDispatcher

Type Parameters

TValue

TValue

The type of the argument passed to subscribers.

THandler

THandler extends EventHandler<TValue> = EventHandler<TValue>

The type of the callback function.

Constructors

Constructor

new EventDispatcherBase<TValue, THandler>(): EventDispatcherBase<TValue, THandler>

Returns

EventDispatcherBase<TValue, THandler>

Properties

subscribable

readonly subscribable: Subscribable<TValue, THandler>

Defined in: events/EventDispatcherBase.ts:15 

Methods

clear()

clear(): void

Defined in: events/EventDispatcherBase.ts:38 

Unsubscribe all subscribers from the event.

Returns

void

notifySubscribers()

protected notifySubscribers(value): ReturnType<THandler>[]

Defined in: events/EventDispatcherBase.ts:42 

Parameters

value

TValue

Returns

ReturnType<THandler>[]

subscribe()

subscribe(handler): () => void

Defined in: events/EventDispatcherBase.ts:23 

Subscribe to the event.

Parameters

handler

THandler

The handler to invoke when the event occurs.

Returns

A callback function that cancels the subscription.

() => void

unsubscribe()

unsubscribe(handler): void

Defined in: events/EventDispatcherBase.ts:31 

Unsubscribe from the event.

Parameters

handler

THandler

The handler to unsubscribe.

Returns

void