@revideo/core

@revideo/core / events / AsyncEventDispatcher

Class: AsyncEventDispatcher<T>

Defined in: events/AsyncEventDispatcher.ts:34 

Dispatches an asynchronous SubscribableEvent.

Remarks

The dispatch method returns a promise that resolves when all the handlers resolve.

Example

class Example {
  // expose the event to external classes
  public get onValueChanged {
    return this.value.subscribable;
  }
  // create a private dispatcher
  private value = new AsyncEventDispatcher<number>();
 
  private async dispatchExample() {
    // dispatching returns a Promise.
    await this.value.dispatch(0);
  }
}

Extends

• EventDispatcherBase<T, AsyncEventHandler<T>>

Type Parameters

T

T

The type of the argument passed to subscribers.

Constructors

Constructor

new AsyncEventDispatcher<T>(): AsyncEventDispatcher<T>

Returns

AsyncEventDispatcher<T>

Inherited from

EventDispatcherBase.constructor

Properties

subscribable

readonly subscribable: Subscribable<T, AsyncEventHandler<T>>

Defined in: events/EventDispatcherBase.ts:15 

Inherited from

EventDispatcherBase.subscribable

Methods

clear()

clear(): void

Defined in: events/EventDispatcherBase.ts:38 

Unsubscribe all subscribers from the event.

Returns

void

Inherited from

EventDispatcherBase.clear

dispatch()

dispatch(value): Promise<void>

Defined in: events/AsyncEventDispatcher.ts:38 

Parameters

value

T

Returns

Promise<void>

notifySubscribers()

protected notifySubscribers(value): Promise<void>[]

Defined in: events/EventDispatcherBase.ts:42 

Parameters

value

T

Returns

Promise<void>[]

Inherited from

EventDispatcherBase.notifySubscribers

subscribe()

subscribe(handler): () => void

Defined in: events/EventDispatcherBase.ts:23 

Subscribe to the event.

Parameters

handler

AsyncEventHandler

The handler to invoke when the event occurs.

Returns

A callback function that cancels the subscription.

() => void

Inherited from

EventDispatcherBase.subscribe

unsubscribe()

unsubscribe(handler): void

Defined in: events/EventDispatcherBase.ts:31 

Unsubscribe from the event.

Parameters

handler

AsyncEventHandler

The handler to unsubscribe.

Returns

void

Inherited from

EventDispatcherBase.unsubscribe