Interface _BaseTypedEventEmitter<T>Internal Category

Typed event emitter with no built in events.

Typed EventEmitter

interface _BaseTypedEventEmitter<T> {
    [captureRejectionSymbol]?<K>(error, event, ...args): void;
    addListener<E>(eventName, listener): this;
    emit<E>(eventName, ...args): boolean;
    eventNames(): Exclude<keyof T, number>[];
    getMaxListeners(): number;
    listenerCount(eventName): number;
    listeners<E>(eventName): T[E][];
    off<E>(eventName, listener): this;
    on<E>(eventName, listener): this;
    once<E>(eventName, listener): this;
    prependListener<E>(eventName, listener): this;
    prependOnceListener<E>(eventName, listener): this;
    rawListeners<E>(eventName): T[E][];
    removeAllListeners(eventName?): this;
    removeListener<E>(eventName, listener): this;
    setMaxListeners(n): this;
}

Type Parameters

Hierarchy

  • EventEmitter
    • _BaseTypedEventEmitter

Methods

[captureRejectionSymbol]? addListener emit eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners

Methods

Optional [captureRejectionSymbol]

  • [captureRejectionSymbol]<K>(error, event, ...args): void

  • Type Parameters

    • K

    Parameters

    • error: Error
    • event: string | symbol
    • Rest ...args: AnyRest

    Returns void

addListener

  • addListener<E>(eventName, listener): this

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns this

emit

  • emit<E>(eventName, ...args): boolean

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • Rest ...args: Parameters<T[E]>

    Returns boolean

eventNames

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Returns number

    Since

    v1.0.0

listenerCount

  • listenerCount(eventName): number

  • Parameters

    • eventName: keyof T

    Returns number

listeners

  • listeners<E>(eventName): T[E][]

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E

    Returns T[E][]

off

  • off<E>(eventName, listener): this

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns this

on

  • on<E>(eventName, listener): this

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns this

once

  • once<E>(eventName, listener): this

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns this

prependListener

  • prependListener<E>(eventName, listener): this

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns this

prependOnceListener

  • prependOnceListener<E>(eventName, listener): this

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns this

rawListeners

  • rawListeners<E>(eventName): T[E][]

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E

    Returns T[E][]

removeAllListeners

  • removeAllListeners(eventName?): this

  • Parameters

    • Optional eventName: keyof T

    Returns this

removeListener

  • removeListener<E>(eventName, listener): this

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns this

setMaxListeners

  • setMaxListeners(n): this

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Parameters

    • n: number

    Returns this

    Since

    v0.3.5

Settings

Member Visibility

Theme

On This Page

[captureRejectionSymbol]addListeneremiteventNamesgetMaxListenerslistenerCountlistenersoffononceprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersetMaxListeners