Interface ControllableReadableStream<T>

An interface for a ControllableStream:class.

interface ControllableReadableStream<T> {
    desiredSize: null | number;
    locked: boolean;
    cancel(reason?): Promise<void>;
    close(): void;
    enqueue(chunk?): void;
    error(e?): void;
    getReader(options): ReadableStreamBYOBReader;
    getReader(): ReadableStreamDefaultReader<T>;
    getReader(options?): ReadableStreamReader<T>;
    onPull(pullListener): (() => void);
    pipeThrough<T>(transform, options?): ReadableStream<T>;
    pipeTo(destination, options?): Promise<void>;
    tee(): [ReadableStream<T>, ReadableStream<T>];
}

Type Parameters

  • T

Hierarchy (view full)

Properties

desiredSize locked

Methods

cancel close enqueue error getReader onPull pipeThrough pipeTo tee

Properties

Readonly desiredSize

desiredSize: null | number

Readonly locked

locked: boolean

Methods

cancel

  • cancel(reason?): Promise<void>

  • Parameters

    • Optional reason: any

    Returns Promise<void>

close

  • close(): void

  • Returns void

enqueue

  • enqueue(chunk?): void

  • Parameters

    • Optional chunk: T

    Returns void

error

  • error(e?): void

  • Parameters

    • Optional e: any

    Returns void

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