@shazow/whatsabi
    Preparing search index...

    Interface WritableStream<W>

    The WritableStream interface of the Streams API 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 = any> {
        locked: boolean;
        abort(reason?: any): Promise<void>;
        close(): Promise<void>;
        getWriter(): WritableStreamDefaultWriter<W>;
    }

    Type Parameters

    • W = any
    Index
    abort close getWriter
    locked

    • The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.

      MDN Reference

      Parameters

      • Optionalreason: any

      Returns Promise<void>

    • The close() method of the WritableStream interface closes the associated stream. All chunks written before this method is called are sent before the returned promise is fulfilled.

      MDN Reference

      Returns Promise<void>

    • The getWriter() method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. While the stream is locked, no other writer can be acquired until this one is released.

      MDN Reference

      Returns WritableStreamDefaultWriter<W>

    locked: boolean

    The locked read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer.

    MDN Reference

    Settings
    Member Visibility

    On This Page
    Methods
    Properties