コンテンツにスキップ

ReadableStream

背景

ReadableStreamは、TransformStream内のreadableプロパティによって返されます。

プロパティ

  • locked boolean
    • 読み取りストリームがリーダーにロックされているかどうかを示すブール値です。

メソッド

  • pipeTo(destinationWritableStream, optionsPipeToOptions) : Promise<void>

    • 読み取りストリームを指定された書き込みストリームdestinationにパイプし、write操作が成功したときに満たされる約束を返します。操作が失敗した場合は拒否されます。
  • getReader(optionsObject) : ReadableStreamDefaultReader

    • ReadableStreamDefaultReaderのインスタンスを取得し、そのリーダーインスタンスにReadableStreamをロックします。このメソッドは、オプションを示すオブジェクト引数を受け入れます。サポートされている唯一のオプションはmodeで、byobに設定することでReadableStreamBYOBReaderを作成できます。以下のように示されます:
let reader = readable.getReader({ mode: 'byob' });

PipeToOptions

  • preventClose bool

    • trueの場合、ソースのReadableStreamのクローズは、宛先のWritableStreamをクローズさせません。
  • preventAbort bool

    • trueの場合、ソースのReadableStreamのエラーは、宛先のWritableStreamを中止させなくなります。pipeToは、ソースからのエラーまたは宛先を中止する際に発生したエラーで拒否された約束を返します。

関連リソース