@nextcloud/dialogs
    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
    closed desiredSize ready
    abort close releaseLock write
    closed: Promise<void>

    The closed read-only property of the the stream errors or the writer's lock is released.

    MDN Reference

    desiredSize: number | null

    The desiredSize read-only property of the to fill the stream's internal queue.

    MDN Reference

    ready: Promise<void>

    The ready read-only property of the 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

    • The abort() method of the 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 stream.

      MDN Reference

      Returns Promise<void>

    • The releaseLock() method of the corresponding stream.

      MDN Reference

      Returns void

    • The write() method of the operation.

      MDN Reference

      Parameters

      • Optionalchunk: W

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods