Documentation
    Preparing search index...

    Class ControllableStream<T>

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

    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 Summary)

    Implements

    Index

    Constructors

    Properties

    locked: boolean

    Accessors

    Methods

    • Parameters

      • Optionaloptions: ReadableStreamIteratorOptions

      Returns ReadableStreamAsyncIterator<T>

    • Parameters

      • Optionalreason: any

      Returns Promise<void>

    • Parameters

      • options: { mode: "byob" }

      Returns ReadableStreamBYOBReader

    • Returns ReadableStreamDefaultReader<T>

    • Parameters

      • Optionaloptions: ReadableStreamGetReaderOptions

      Returns ReadableStreamReader<T>

    • Type Parameters

      • T

      Parameters

      • transform: ReadableWritablePair<T, T>
      • Optionaloptions: StreamPipeOptions

      Returns ReadableStream<T>

    • Parameters

      • destination: WritableStream<T>
      • Optionaloptions: StreamPipeOptions

      Returns Promise<void>

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

    • Parameters

      • Optionaloptions: ReadableStreamIteratorOptions

      Returns ReadableStreamAsyncIterator<T>

    • Type Parameters

      • R = any

      Parameters

      • iterable: Iterable<R, any, any> | AsyncIterable<R, any, any>

      Returns ReadableStream<R>