Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface _BaseTypedEventEmitter<T>

Typed event emitter with no built in events.

internal

Type Parameters

Hierarchy

Index

Methods

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns _BaseTypedEventEmitter<T>

  • emit<E>(eventName: E, ...args: Parameters<T[E]>): boolean
  • Type Parameters

    • E extends string | number | symbol

    Parameters

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

    Returns boolean

  • eventNames(): Exclude<keyof T, number>[]
  • Returns Exclude<keyof T, number>[]

  • getMaxListeners(): number
  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

    since

    v1.0.0

    Returns number

  • listenerCount(eventName: keyof T): number
  • Parameters

    • eventName: keyof T

    Returns number

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

    • E extends string | number | symbol

    Parameters

    • eventName: E

    Returns T[E][]

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns _BaseTypedEventEmitter<T>

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns _BaseTypedEventEmitter<T>

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns _BaseTypedEventEmitter<T>

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns _BaseTypedEventEmitter<T>

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns _BaseTypedEventEmitter<T>

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

    • E extends string | number | symbol

    Parameters

    • eventName: E

    Returns T[E][]

  • Parameters

    • Optional eventName: keyof T

    Returns _BaseTypedEventEmitter<T>

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    • eventName: E
    • listener: T[E]

    Returns _BaseTypedEventEmitter<T>

  • 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.

    since

    v0.3.5

    Parameters

    • n: number

    Returns _BaseTypedEventEmitter<T>

Generated using TypeDoc