Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventEmitter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns EventEmitter

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: ((...args: any[]) => void)): EventEmitter

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: ((...args: any[]) => void)): EventEmitter

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

on

  • on(event: string | symbol, listener: ((...args: any[]) => void)): EventEmitter

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

once

  • once(event: string | symbol, listener: ((...args: any[]) => void)): EventEmitter

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

prependListener

  • prependListener(event: string | symbol, listener: ((...args: any[]) => void)): EventEmitter

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): EventEmitter

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

removeListener

  • removeListener(event: string | symbol, listener: ((...args: any[]) => void)): EventEmitter

  • Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

setMaxListeners

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc