ReadableStream

最后更新 2026年8月9日查看 MarkdownAgent 设置

背景

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

属性

locked boolean
- 布尔值，表示可读流是否已锁定到某个 reader。

方法

pipeTo(destinationWritableStream, optionsPipeToOptions) : Promise<void>
- 将可读流管道传输到给定的可写流 destination，并返回一个在 write 操作成功时 fulfilled、失败时 rejected 的 promise。
getReader(optionsObject) : ReadableStreamDefaultReader
- 获取 ReadableStreamDefaultReader 实例，并将 ReadableStream 锁定到该 reader 实例。此方法接受一个表示选项的对象参数。唯一支持的选项是 mode，可设置为 byob 以创建 ReadableStreamBYOBReader，如下所示：

let reader = readable.getReader({ mode: 'byob' });

`PipeToOptions`

preventClose bool
- 当为 true 时，源 ReadableStream 的关闭不会导致目标 WritableStream 被关闭。
preventAbort bool
- 当为 true 时，源 ReadableStream 中的错误将不再 abort 目标 WritableStream。pipeTo 将返回一个 rejected promise，其中包含源的错误或在 abort 目标时发生的任何错误。

相关资源

这篇文档对您有帮助吗？