modal-ts
    Preparing search index...

    Interface ModalReadStream<R>

    ReadableStream に便利なメソッドを追加したラッパーインターフェース

    .readText() でストリーム全体を文字列として読み取り、 .readBytes() でバイナリデータとして読み取ることができる。

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

    interface ModalReadStream<R = unknown> {
        locked: boolean;
        "[asyncIterator]"(): ReadableStreamAsyncIterator<R>;
        cancel(reason?: any): Promise<void>;
        getReader(options: { mode: "byob" }): ReadableStreamBYOBReader;
        getReader(): ReadableStreamDefaultReader<R>;
        getReader(
            options?: ReadableStreamGetReaderOptions,
        ): ReadableStreamReader<R>;
        pipeThrough<T>(
            transform: ReadableWritablePair<T, R>,
            options?: StreamPipeOptions,
        ): ReadableStream<T>;
        pipeTo(
            destination: WritableStream<R>,
            options?: StreamPipeOptions,
        ): Promise<void>;
        readBytes(): Promise<Uint8Array<ArrayBufferLike>>;
        readText(): Promise<string>;
        tee(): [ReadableStream<R>, ReadableStream<R>];
        values(
            options?: { preventCancel?: boolean },
        ): ReadableStreamAsyncIterator<R>;
    }

    Type Parameters

    • R = unknown

    Hierarchy

    • ReadableStream<R>
      • ModalReadStream
    Index

    Properties

    locked

    Methods

    [asyncIterator] cancel getReader pipeThrough pipeTo readBytes readText tee values

    Properties

    locked: boolean

    Methods

    • Returns ReadableStreamAsyncIterator<R>

    • Parameters

      • Optionalreason: any

      Returns Promise<void>

    • Parameters

      • options: { mode: "byob" }

      Returns ReadableStreamBYOBReader

    • Returns ReadableStreamDefaultReader<R>

    • Parameters

      • Optionaloptions: ReadableStreamGetReaderOptions

      Returns ReadableStreamReader<R>

    • Type Parameters

      • T

      Parameters

      • transform: ReadableWritablePair<T, R>
      • Optionaloptions: StreamPipeOptions

      Returns ReadableStream<T>

    • Parameters

      • destination: WritableStream<R>
      • Optionaloptions: StreamPipeOptions

      Returns Promise<void>

    • Returns Promise<Uint8Array<ArrayBufferLike>>

      ストリーム全体をバイト配列として読み取る

    • Returns Promise<string>

      ストリーム全体を文字列として読み取る

    • Returns [ReadableStream<R>, ReadableStream<R>]

    • Parameters

      • Optionaloptions: { preventCancel?: boolean }

      Returns ReadableStreamAsyncIterator<R>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods