@nextcloud/dialogs
    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.

    MDN Reference

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

    Type Parameters

    • W = any

    Hierarchy (View Summary)

    Index
    locked
    abort close getWriter
    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

    • 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.

      MDN Reference

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods