@shazow/whatsabi
    Preparing search index...

    Interface WritableStreamDefaultWriter<W>

    The WritableStreamDefaultWriter interface of the Streams API is the object returned by WritableStream.getWriter() and once created locks the writer to the WritableStream ensuring that no other streams can write to the underlying sink.

    MDN Reference

    interface WritableStreamDefaultWriter<W = any> {
        closed: Promise<void>;
        desiredSize: number | null;
        ready: Promise<void>;
        abort(reason?: any): Promise<void>;
        close(): Promise<void>;
        releaseLock(): void;
        write(chunk?: W): Promise<void>;
    }

    Type Parameters

    • W = any
    Index
    • The abort() method of the WritableStreamDefaultWriter 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 WritableStreamDefaultWriter interface closes the associated writable stream.

      MDN Reference

      Returns Promise<void>

    • The releaseLock() method of the WritableStreamDefaultWriter interface releases the writer's lock on the corresponding stream. After the lock is released, the writer is no longer active. If the associated stream is errored when the lock is released, the writer will appear errored in the same way from now on; otherwise, the writer will appear closed.

      MDN Reference

      Returns void

    • The write() method of the WritableStreamDefaultWriter interface writes a passed chunk of data to a WritableStream and its underlying sink, then returns a Promise that resolves to indicate the success or failure of the write operation.

      MDN Reference

      Parameters

      • Optionalchunk: W

      Returns Promise<void>

    closed: Promise<void>

    The closed read-only property of the WritableStreamDefaultWriter interface returns a Promise that fulfills if the stream becomes closed, or rejects if the stream errors or the writer's lock is released.

    MDN Reference

    desiredSize: number | null

    The desiredSize read-only property of the WritableStreamDefaultWriter interface returns the desired size required to fill the stream's internal queue.

    MDN Reference

    ready: Promise<void>

    The ready read-only property of the WritableStreamDefaultWriter interface returns a Promise that resolves when the desired size of the stream's internal queue transitions from non-positive to positive, signaling that it is no longer applying backpressure.

    MDN Reference