@revideo/core

@revideo/core / events / FlagDispatcher

Class: FlagDispatcher

Defined in: events/FlagDispatcher.ts:31 

Dispatches a SubscribableFlagEvent.

Remarks

Subscribers are notified only when the flag is set. Subsequent calls to raise don’t trigger anything. Any handlers added while the flag is raised are immediately invoked.

Resetting the flag doesn’t notify the subscribers, but raising it again does.

Example

class Example {
  // expose the event to external classes
  public get onChanged {
    return this.flag.subscribable;
  }
  // create a private dispatcher
  private flag = new FlagDispatcher();
 
  private dispatchExample() {
    // setting the flag will notify all subscribers
    this.flag.raise();
  }
}

Extends

• EventDispatcherBase<void>

Constructors

Constructor

new FlagDispatcher(): FlagDispatcher

Returns

FlagDispatcher

Inherited from

EventDispatcherBase.constructor

Properties

subscribable

readonly subscribable: Subscribable<void, EventHandler<void>>

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

isRaised()

isRaised(): boolean

Defined in: events/FlagDispatcher.ts:54 

Are subscribers being notified?

Returns

boolean

notifySubscribers()

protected notifySubscribers(value): any[]

Defined in: events/EventDispatcherBase.ts:42 

Parameters

value

void

Returns

any[]

Inherited from

EventDispatcherBase.notifySubscribers

raise()

raise(): void

Defined in: events/FlagDispatcher.ts:37 

Notify all current and future subscribers.

Returns

void

reset()

reset(): void

Defined in: events/FlagDispatcher.ts:47 

Stop notifying future subscribers.

Returns

void

subscribe()

subscribe(handler): () => void

Defined in: events/FlagDispatcher.ts:58 

Subscribe to the event.

Parameters

handler

EventHandler<void>

The handler to invoke when the event occurs.

Returns

A callback function that cancels the subscription.

() => void

Overrides

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