Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReadableStreamEvents<T>

Type Parameters

  • T

Hierarchy

Index

Methods

Methods

  • on(event: "data", callback: ((data: T) => void)): void
  • on(event: "error", callback: ((err: Error) => void)): void
  • on(event: "end", callback: (() => void)): void
  • The 'data' event is emitted whenever the stream is relinquishing ownership of a chunk of data to a consumer.

    Parameters

    • event: "data"
    • callback: ((data: T) => void)
        • (data: T): void
        • Parameters

          • data: T

          Returns void

    Returns void

  • Emitted when any error occurs.

    Parameters

    • event: "error"
    • callback: ((err: Error) => void)
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • The 'end' event is emitted when there is no more data to be consumed from the stream. The 'end' event will not be emitted unless the data is completely consumed.

    Parameters

    • event: "end"
    • callback: (() => void)
        • (): void
        • Returns void

    Returns void