边缘开发者平台
  • 边缘函数
    • 概述
    • 快速指引
    • 操作指引
      • 函数管理
      • 触发配置
    • Runtime APIs
      • addEventListener
      • Cache
      • Cookies
      • Encoding
      • Fetch
      • FetchEvent
      • Headers
      • Request
      • Response
      • Streams
        • ReadableStream
        • ReadableStreamBYOBReader
        • ReadableStreamDefaultReader
        • TransformStream
        • WritableStream
        • WritableStreamDefaultWriter
      • Web Crypto
      • Web standards
      • Images
        • ImageProperties
    • 示例函数
      • 返回 HTML 页面
      • 返回 JSON
      • Fetch 远程资源
      • 请求头鉴权
      • 修改响应头
      • AB 测试
      • 设置 Cookie
      • 基于请求区域重定向
      • Cache API 使用
      • 缓存 POST 请求
      • 流式响应
      • 合并资源流式响应
      • 防篡改校验
      • m3u8 改写与鉴权
      • 图片自适应缩放
      • 图片自适应 WebP
      • 自定义 Referer 限制规则
      • 远程鉴权
      • HMAC 数字签名
      • 自定义下载文件名
      • 获取客户端 IP
    • 最佳实践
      • 通过边缘函数实现自适应图片格式转换
Docs Overview/
边缘开发者平台/
边缘函数/
Runtime APIs/
Streams/
ReadableStreamDefaultReader/

ReadableStreamDefaultReader

ReadableStreamDefaultReader 用于可读流操作，基于 Web APIs 标准 ReadableStreamDefaultReader 进行设计。
注意：
不支持直接构造 ReadableStreamDefaultReader 对象，使用 ReadableStream.getReader 方法得到。

描述

// 使用 TransformStream 构造得到 ReadableStream 对象
const { readable } = new TransformStream();

// 使用 ReadableStream 对象获取 reader
const reader = readable.getReader();

属性

closed

// reader.closed
readonly closed: Promise<void>;
返回 Promise 对象，如果流已关闭，Promise 状态为 fulfilled，如果流发生错误或读端锁已释放，Promise 状态为 rejected。

方法

read

reader.read(): Promise<{value: Chunk, done: boolean}>;
从流中读取数据。
注意：
不允许前一个流读取操作结束前，调用 read 方法发起下一个流读取操作。

返回值

reader.read 返回 Promise 包含读取的数据（Chunk）与读取状态，说明如下：
如果有一个 chunk 可用，Promise 为 fulfilled 状态，包含 { value: theChunk, done: false } 格式的对象。
如果流被关闭，Promise 为 fulfilled 状态，包含 { value: undefined, done: true } 格式的对象。
如果流出错，Promise 为 rejected 状态，并包含相关错误信息。

Chunk

从流中读取的数据 Chunk，描述如下：
type Chunk = string | ArrayBuffer | ArrayBufferView;

cancel

reader.cancel(reason?: string): Promise<string>;
关闭流并结束读取操作。

releaseLock

reader.releaseLock(): void;
取消与流的关联，并释放流的锁定。

相关参考

MDN 官方文档：ReadableStreamDefaultReader