Interface WritableStream<W>

This Streams API interface provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in back pressure and queuing.

interface WritableStream<W = any> {
    locked: boolean;
    abort(reason?: any): Promise<void>;
    close(): Promise<void>;
    getWriter(): WritableStreamDefaultWriter<W>;
}

Type Parameters

  • W = any

Properties

locked

Methods

abort close getWriter

Properties

Readonlylocked

locked: boolean

Methods

abort

  • abort(reason?: any): Promise<void>

  • Parameters

    • Optionalreason: any

    Returns Promise<void>

close

  • close(): Promise<void>

  • Returns Promise<void>

getWriter

Settings

Member Visibility

On This Page

Properties
Methods