Class ControllableStream<T>

A ControllableStream is ReadableStream that can have chunks queued to from an external source.

Example

Queuing items externally.

const controller = new ControllableStream<number>()
controller.enqueue(1)
controller.enqueue(2)
controller.enqueue(3)
controller.close()

Registering pull subscribers externally.

const controller = new ControllableStream<number>()
let i = -1
controller.onPull(() => ++i)

Type Parameters

  • T

Hierarchy (view full)

Implements

Constructors

constructor

Properties

#source locked

Accessors

desiredSize

Methods

cancel close enqueue error getReader onPull pipeThrough pipeTo tee

Constructors

constructor

Properties

Private Readonly #source

#source: ControllableSource<T>

Readonly locked

locked: boolean

Accessors

desiredSize

Methods

cancel

  • cancel(reason?): Promise<void>

  • Parameters

    • Optional reason: any

    Returns Promise<void>

close

enqueue

error

getReader

  • getReader(options): ReadableStreamBYOBReader

  • Parameters

    • options: {
          mode: "byob";
      }
      • mode: "byob"

    Returns ReadableStreamBYOBReader

  • getReader(): ReadableStreamDefaultReader<T>

  • Returns ReadableStreamDefaultReader<T>

  • getReader(options?): ReadableStreamReader<T>

  • Parameters

    • Optional options: ReadableStreamGetReaderOptions

    Returns ReadableStreamReader<T>

onPull

pipeThrough

  • pipeThrough<T>(transform, options?): ReadableStream<T>

  • Type Parameters

    • T

    Parameters

    • transform: ReadableWritablePair<T, T>
    • Optional options: StreamPipeOptions

    Returns ReadableStream<T>

pipeTo

  • pipeTo(destination, options?): Promise<void>

  • Parameters

    • destination: WritableStream<T>
    • Optional options: StreamPipeOptions

    Returns Promise<void>

tee

  • tee(): [ReadableStream<T>, ReadableStream<T>]

  • Returns [ReadableStream<T>, ReadableStream<T>]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc