边缘开发者平台
  • 边缘函数
    • 概述
    • 快速指引
    • 操作指引
      • 函数管理
      • 触发配置
    • 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
    • 最佳实践
      • 通过边缘函数实现自适应图片格式转换

WritableStreamDefaultWriter

WritableStreamDefaultWriter 用于可写流的操作。基于 Web APIs 标准 WritableStreamDefaultWriter 进行设计。
注意:
不支持直接构造 WritableStreamDefaultWriter 对象,使用 WritableStream.getWriter 方法得到。

描述

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

// 使用 WritableStream 对象获取 writer
const writer = writable.getWriter();

属性

closed

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

ready

// writer.ready
readonly ready: Promise<void>;
返回 Promise 对象,当流的内部队列的所需大小从负变为正时,该 Promise 状态为 fulfilled,表示它不再施加背压。

desiredSize

// writer.desiredSize
readonly desiredSize: number;
返回填充流的内部队列所需的大小。

方法

write

writer.write(chunk: Chunk): Promise<void>;
chunk 数据写入流中。
注意:
不允许前一个写流操作结束前,调用 write 方法发起下一个写流操作。

参数

参数名称
类型
必填
说明
chunk
待写入流的 chunk 数据。

Chunk

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

close

writer.close(): Promise<void>;
关闭当前流。

abort

writer.abort(reason?: string): Promise<string>;
终止当前流。

releaseLock

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

相关参考