Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TypedEventEmitter<T>

A type-checked EventEmitter.

example
import { EventEmitter } from 'events';

type Events = {
    success: () => void;
    error: (error: Error) => void;
};

class TypedClass extends (EventEmitter as new () => TypedEventEmitter<Events>) {}

Type Parameters

  • T extends EventListeners = Record<never, never>

    The event names and listener signatures

Hierarchy

Index

Methods

Methods

addListener

emit

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

  • Type Parameters

    • E extends string | number | symbol

    Parameters

    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 {@link defaultMaxListeners}.

    since

    v1.0.0

    Returns number

listenerCount

listeners

off

on

once

prependListener

prependOnceListener

rawListeners

removeAllListeners

removeListener

setMaxListeners

  • 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 TypedEventEmitter<T>

Generated using TypeDoc