Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReadableStreamDefaultController<R>

Allows control of a readable stream's state and internal queue.

Type parameters

  • R

Hierarchy

  • ReadableStreamDefaultController

Index

Accessors

desiredSize

  • get desiredSize(): null | number
  • Returns the desired size to fill the controlled stream's internal queue. It can be negative, if the queue is over-full. An underlying source ought to use this information to determine when and how to apply backpressure.

    Returns null | number

Methods

close

  • close(): void
  • Closes the controlled readable stream. Consumers will still be able to read any previously-enqueued chunks from the stream, but once those are read, the stream will become closed.

    Returns void

enqueue

  • enqueue(chunk: R): void
  • Enqueues the given chunk chunk in the controlled readable stream.

    Parameters

    • chunk: R

    Returns void

error

  • error(e?: any): void
  • Errors the controlled readable stream, making all future interactions with it fail with the given error e.

    Parameters

    • Optional e: any

    Returns void

Generated using TypeDoc