跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

ReadableStream

最后更新 查看 MarkdownAgent 设置

背景

ReadableStream 由 TransformStream 内部的 readable 属性返回。

属性

  • locked boolean
    • 布尔值,表示可读流是否已锁定到某个 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);
}

PipeToOptions

  • preventClose bool

    • 当为 true 时,源 ReadableStream 的关闭不会导致目标 WritableStream 被关闭。
  • preventAbort bool

    • 当为 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';
  })()
);

相关资源

这篇文档对您有帮助吗?