@revideo/core

@revideo/core / events / EventDispatcher

Class: EventDispatcher<T>

Defined in: events/EventDispatcher.ts:26 

Dispatches a SubscribableEvent.

Example

class Example {
  // expose the event to external classes
  public get onValueChanged {
    return this.value.subscribable;
  }
  // create a private dispatcher
  private value = new EventDispatcher<number>();
 
  private dispatchExample() {
    // dispatching will notify all subscribers.
    this.value.dispatch(0);
  }
}

Extends

• EventDispatcherBase<T>

Type Parameters

T

T

The type of the value argument to subscribers.

Constructors

Constructor

new EventDispatcher<T>(): EventDispatcher<T>

Returns

EventDispatcher<T>

Inherited from

EventDispatcherBase.constructor

Properties

subscribable

readonly subscribable: Subscribable<T, EventHandler<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): void

Defined in: events/EventDispatcher.ts:27 

Parameters

value

T

Returns

void

notifySubscribers()

protected notifySubscribers(value): any[]

Defined in: events/EventDispatcherBase.ts:42 

Parameters

value

T

Returns

any[]

Inherited from

EventDispatcherBase.notifySubscribers

subscribe()

subscribe(handler): () => void

Defined in: events/EventDispatcherBase.ts:23 

Subscribe to the event.

Parameters

handler

EventHandler

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

EventHandler

The handler to unsubscribe.

Returns

void

Inherited from

EventDispatcherBase.unsubscribe