modal
    Preparing search index...

    Interface ModalWriteStream<R>

    Wrapper around WritableStream with convenience functions.

    The Stream API is a modern standard for asynchronous data streams across network and process boundaries. It allows you to read data in chunks, pipe and transform it, and handle backpressure.

    This wrapper adds some extra functions like .writeText() to write a string to the stream, or writeBytes() to write binary data.

    Background: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API

    interface ModalWriteStream<R = any> {
        locked: boolean;
        abort(reason?: any): Promise<void>;
        close(): Promise<void>;
        getWriter(): WritableStreamDefaultWriter<R>;
        writeBytes(bytes: Uint8Array): Promise<void>;
        writeText(text: string): Promise<void>;
    }

    Type Parameters

    • R = any

    Hierarchy

    • WritableStream<R>
      • ModalWriteStream
    Index

    Properties

    locked

    Methods

    abort close getWriter writeBytes writeText

    Properties

    locked: boolean

    Methods

    • Parameters

      • Optionalreason: any

      Returns Promise<void>

    • Returns Promise<void>

    • Returns WritableStreamDefaultWriter<R>

    • Write a byte array to the stream. Only if this is a byte stream.

      Parameters

      • bytes: Uint8Array

      Returns Promise<void>

    • Write a string to the stream. Only if this is a text stream.

      Parameters

      • text: string

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods