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 backpressure and queuing.

MDN Reference

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

Type Parameters

  • W = any

Properties

locked

Methods

abort close getWriter

Properties

Readonly locked

locked: boolean

MDN Reference

Methods

abort

  • abort(reason?): Promise<void>

  • MDN Reference

    Parameters

    • Optional reason: any

    Returns Promise<void>

close

  • close(): Promise<void>

  • MDN Reference

    Returns Promise<void>

getWriter

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc