tencent cloud

Tencent Cloud EdgeOne

ReadableStream

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-11-04 10:29:57
AI翻訳・品質チェック済み
ReadableStreamは読み取り可能なストリームであり、読み取り可能端とも呼ばれます。Web APIs標準ReadableStreamに基づいて設計されています。
注意:
ReadableStreamオブジェクトを直接構築することはサポートされていません。TransformStreamを使用して構築します。

説明

// TransformStreamを使用してReadableStreamオブジェクトを構築します。
const { readable } = new TransformStream();

属性

// readable.locked
readonly locked: boolean;
ストリームがロックされているかどうかを示します。
説明:
ストリームがロック状態にある場合には、以下のものがあります:
1つのストリームには最大で1つのアクティブなreaderが存在し、readerがreleaseLock()メソッドを呼び出す前まで、そのストリームはロック状態にあります。
ストリームがパイプライン転送中にある場合、ロック状態になり、パイプライン転送が終了するまでその状態が続きます。

方法

注意:
以下に示すすべてのメソッドを使用する際は、現在のストリームが非ロック状態である必要があります。そうでない場合、例外がスローされます。

getReader

readable.getReader(options?: ReaderOptions): ReadableStreamDefaultReader | ReadableStreamBYOBReader;
Readerを作成し、ReaderがreleaseLock()を呼び出してロックを解放するまで、現在のストリームをロックします。

パラメータ

パラメータ名
タイプ
必須
説明
options
はい
Readerの設定項目を生成します。

ReaderOptions

ReaderOptionsオブジェクトの属性は以下の通りです。
属性名
タイプ
必須
説明
mode
string
いいえ
Reader 型、既定値は undefined。値の取り得る仕様は以下の通り。
undefined
ReadableStreamDefaultReaderタイプのReaderを作成します。
byob
ReadableStreamBYOBReaderタイプのReaderを作成します。

pipeThrough

readable.pipeThrough(transformStream: TransfromStream, options?: PipeToOptions): ReadableStream;
ストリームのパイプライン処理です。現在の読み取り可能なストリームデータをパラメータtransfromStreamのwritable端に転送し、transfromStreamのreadable端を返します。
注意:
パイプライン転送中、現在のストリームのwritable側がロックされます。

パラメータ

パラメータ名
タイプ
必須
説明
transfromStream
はい
現在のストリームの転送先オブジェクト。
options
はい
ストリーム処理の設定項目。

PipeToOptions

ストリーム処理の設定項目は以下の通りです:
属性名
タイプ
必須
説明
preventClose
boolean
いいえ
値を true に設定した場合、読み取り可能ストリームを閉じても、書き込み可能ストリームは閉じられないことを示します。
preventAbort
boolean
いいえ
値を true に設定した場合、読み取り可能ストリームでエラーが発生しても、書き込み可能ストリームは中止されないことを示します。
preventCancel
boolean
いいえ
値を true に設定した場合、書き込み可能ストリームのエラーが、読み取り可能ストリームの終了を引き起こすことはないことを示します。
signal
いいえ
「signal」が中止されると、進行中の転送が中止されます。

pipeTo

readable.pipeTo(destination: WritableStream, options?: PipeToOptions): Promise<void>;
ストリームのパイプライン処理です。現在の読み取り可能なストリームを destination 書き込み可能なストリームに転送します。
注意:
パイプライン転送中、現在のストリームdestinationがロックされます。

パラメータ

パラメータ名
タイプ
必須
説明
destination
はい
書き込み可能なストリーム。
options
はい
ストリーム処理の設定項目。

tee

readable.tee(): [ReadableStream, ReadableStream];
現在のストリームから2つの独立した読み取り可能なストリームを生成します。

cancel

readable.cancel(reason?: string): Promise<string>;
現在のストリームを終了します。

関連参考

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック