Class EventEmitter<EventMap>

Base class for objects that dispatches events.

Example

var emitter = new EventEmitter();
    emitter.on('myEvent', function(evt){
        console.log(evt.message);
    });
    emitter.emit({
        type: 'myEvent',
        message: 'Hello world!'
    });

Type Parameters

  • EventMap extends Record<string, any> = Record<string, any>

Hierarchy

Constructors

constructor

Methods

emit has off on

Constructors

constructor

  • Type Parameters

    • EventMap extends Record<string, any> = Record<string, any>

    Returns EventEmitter<EventMap>

Methods

emit

  • Emit an event.

    Type Parameters

    • E extends string | number | symbol

    Parameters

    • event: EventMap[E]

    Returns EventEmitter<EventMap>

    The self object, for chainability.

    Example

    emitter.emit({
            type: 'myEvent',
            customData: 123
        });

has

  • Check if an event listener is added

    Type Parameters

    • E extends string | number | symbol

    Parameters

    • type: E
    • Optional listener: Function

    Returns boolean

off

  • Remove an event listener

    Type Parameters

    • E extends string | number | symbol

    Parameters

    • type: E
    • listener: Function

    Returns EventEmitter<EventMap>

    The self object, for chainability.

    Example

    emitter.on('myEvent', handler); // Add handler
        emitter.off('myEvent', handler); // Remove handler

on

  • Add an event listener

    Type Parameters

    • E extends string | number | symbol

    Parameters

    • type: E
    • listener: ((e) => void)
        • (e): void

        • Parameters

          • e: EventMap[E]

          Returns void

    • Optional context: any

    Returns EventEmitter<EventMap>

    The self object, for chainability.

    Example

    emitter.on('myEvent', function(evt){
            console.log('myEvt was triggered!');
        });

Settings

Member Visibility

Theme

On This Page