Class EventEmitter<T>

Emits events to registered listeners.

Example

const emitter = new EventEmitter<string>();

const sub = emitter.event((msg) => console.log(msg));
emitter.fire('hello'); // logs: hello
sub.dispose();
emitter.fire('world'); // nothing happens

Type Parameters

  • T

Implements

Constructors

constructor

Properties

event

Accessors

listenerCount

Methods

dispose fire once

Constructors

constructor

Properties

Readonlyevent

event: Event<T> = ...

The event that listeners can subscribe to.

Accessors

listenerCount

  • get listenerCount(): number

    Get the current number of listeners.

    Returns number

Methods

dispose

fire

  • fire(data: T): void

    Fire the event, notifying all listeners.

    Parameters

    • data: T

      The event data to send to listeners

    Returns void

once

  • once(listener: (e: T) => void): IDisposable

    Subscribe to the event, but only fire once.

    Parameters

    • listener: (e: T) => void

      Callback to invoke once

    Returns IDisposable

    Disposable to cancel before the event fires

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods