Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Stream

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

Methods

Static once

Static on

Static listenerCount

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

on

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

removeAllListeners

setMaxListeners

getMaxListeners

  • getMaxListeners(): number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

emit

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

  • Parameters

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

    Returns boolean

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

eventNames

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

  • Returns (string | symbol)[]

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type Parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

Properties

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.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Generated using TypeDoc