ReadableStream 由 TransformStream 内部的 readable 属性返回。
lockedboolean- 布尔值,表示可读流是否已锁定到某个 reader。
-
pipeTo(destinationWritableStream, optionsPipeToOptions): Promise<void>- 将可读流管道传输到给定的可写流
destination,并返回一个在write操作成功时 fulfilled、失败时 rejected 的 promise。
- 将可读流管道传输到给定的可写流
-
pipeThrough(transformStream, optionsPipeToOptions): ReadableStream- 将可读流管道传输到给定
TransformStream的可写侧,并返回该 transform 的可读侧,以便链式调用。options接受与pipeTo()相同的值。
- 将可读流管道传输到给定
-
getReader(optionsObject): ReadableStreamDefaultReader- 获取
ReadableStreamDefaultReader实例,并将ReadableStream锁定到该 reader 实例。此方法接受一个表示选项的对象参数。唯一支持的选项是mode,可设置为byob以创建ReadableStreamBYOBReader,如下所示:
- 获取
let reader = readable.getReader({ mode: 'byob' });-
cancel(reasonstringoptional): Promise<void>- 取消流。
reason是可选的人类可读字符串,说明取消原因。reason会传给底层源的 cancel 算法。尚未读取的数据会丢失。
- 取消流。
-
tee(): [ReadableStream, ReadableStream]- 锁定流并返回两个新的
ReadableStream实例数组,每个实例都读取与原始流相同的数据。对底层源的反压跟随未读数据最多的分支,只要底层源响应反压,就可以避免一个分支比另一个读得慢时出现无界缓冲。实现细节请参阅 workerd 的 streams 文档 ↗。
- 锁定流并返回两个新的
-
values(optionsObject): AsyncIterableIterator- 返回读取并消费流块的异步迭代器。此方法接受一个表示选项的对象参数。唯一支持的选项是
preventCancel,当为true时,会阻止迭代器提前退出(例如break语句)时取消流。ReadableStream也可以直接异步迭代:
- 返回读取并消费流块的异步迭代器。此方法接受一个表示选项的对象参数。唯一支持的选项是
for await (const chunk of readable) {
console.log(chunk);
}for await (const chunk of readable) {
console.log(chunk);
}-
preventClosebool- 当为
true时,源ReadableStream的关闭不会导致目标WritableStream被关闭。
- 当为
-
preventAbortbool- 当为
true时,源ReadableStream中的错误将不再 abort 目标WritableStream。pipeTo将返回一个 rejected promise,其中包含源的错误或在 abort 目标时发生的任何错误。
- 当为
-
ReadableStream.from(asyncIterable): ReadableStream- 创建一个新的
ReadableStream,其块为asyncIterable产出的值。asyncIterable可以是任何可迭代或异步可迭代对象,包括异步生成器。
- 创建一个新的
const stream = ReadableStream.from(
(async function* () {
yield "hello ";
yield "world";
})(),
);const stream = ReadableStream.from(
(async function* () {
yield 'hello ';
yield 'world';
})()
);