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

WritableStream

WritableStream 可写流,也称为可写端。基于 Web APIs 标准 WritableStream 进行设计。
注意:
不支持直接构造 WritableStream 对象,使用 TransformStream 构造得到。

描述

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

属性

locked

// writable.locked
readonly locked: boolean;
标识流是否已锁定。
说明:
流处于锁定状态的情况有:
一个流最多有一个激活的 writer,在 writer 调用 releaseLock() 方法前,该流均处于锁定状态。
流处于管道传输中,会处于锁定状态,直至管道传输结束。

highWaterMark

// writable.highWaterMark
readonly highWaterMark: number;
可写端缓冲区大小,以字节为单位,默认值为 32K, 最大值为 256K, 超过最大值则会自动调整为 256K。

方法

注意:
使用下述所有方法,要求当前流处于非锁定状态,否则会抛出异常。

getWriter

writable.getWriter(): WritableStreamDefaultWriter;
创建一个 writer,并锁定当前流,直至 writer 调用 releaseLock() 方法释放锁。返回值参见 WritableStreamDefaultWriter

close

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

abort

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

相关参考