Interface TypedEventEmitter<T>

Typed event emitter that works both for Web and React Native.

Type Param

interface TypedEventEmitter<T> {
    addListener<K>(type, listener): this;
    emit<K>(type, params): boolean;
    getMaxListeners(): number;
    listenerCount<K>(type): number;
    removeListener<K>(type, listener): this;
    setMaxListeners(n): this;
}

Type Parameters

Methods

addListener emit getMaxListeners listenerCount removeListener setMaxListeners

Methods

addListener

  • addListener<K>(type, listener): this

  • Adds the specified listener function to the end of the listeners array for the event of the given type.

    Type Parameters

    • K extends string

    Parameters

    • type: K

      A case-sensitive string representing the event type to listen for.

    • listener: EventReceiver<T[K]>

      The callback function.

    Returns this

    A reference to the EventEmitter.

emit

  • emit<K>(type, params): boolean

  • Synchronously calls each of the listeners registered for the given event type, in the order they were registered, passing the supplied arguments.

    Type Parameters

    • K extends string

    Parameters

    • type: K

      A case-sensitive string representing the event type.

    • params: T[K]

      Optional parameters.

    Returns boolean

    Whether the event had listeners.

getMaxListeners

listenerCount

removeListener

  • removeListener<K>(type, listener): this

  • Removes the specified listener function from the listener array for the event of the given type.

    Type Parameters

    • K extends string

    Parameters

    • type: K

      A case-sensitive string representing the event type.

    • listener: EventReceiver<T[K]>

      The callback function to unregister.

    Returns this

    A reference to the EventEmitter.

setMaxListeners

  • setMaxListeners(n): this

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. Use this function to modify the default threshold.

    Parameters

    • n: number

      Number of listeners before printing a warning. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns this

    A reference to the EventEmitter.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc