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 {
    locked: boolean;
    abort(reason?): Promise<void>;
    close(): Promise<void>;
    getWriter(): WritableStreamDefaultWriter<W>;
}

Type Parameters

W = any

Index

Methods

abort close getWriter

Properties

Methods

abort

abort(reason?): Promise<void>
Parameters
- Optional reason: any
Returns Promise<void>

close

close(): Promise<void>
Returns Promise<void>

getWriter

getWriter(): WritableStreamDefaultWriter<W>
Returns WritableStreamDefaultWriter<W>

Properties

`Readonly` locked

locked: boolean