tencent cloud

边缘安全加速平台 EO

动态与公告
产品动态
安全公告
产品公告
产品简介
产品概述
产品优势
应用场景
EdgeOne 与 CDN 等产品功能对比
使用限制
购买指南
试用套餐体验权益说明
免费版套餐使用说明
计费概述
计费项目
购买指引
续费指引
欠费与退款说明
套餐选型对比
关于“干净流量”计费说明
DDoS 防护容量说明
快速入门
选择业务场景
快速接入网站安全加速
通过 Pages 快速部署网站
域名服务与源站配置
域名服务
HTTPS 证书
源站配置
站点加速
概述
访问控制
智能加速
缓存配置
文件优化
网络优化
URL 重写
修改头部
修改应答内容
规则引擎
图片与视频处理
单连接下载限速
DDoS 与 Web 防护
概述
DDoS 防护
Web 防护
Bot 管理
API 资产识别(Beta)
边缘函数
概述
快速指引
操作指引
Runtime APIs
示例函数
实践教程
Pages
四层代理
概述
新建四层代理实例
修改四层代理实例配置
停用/删除四层代理实例
批量配置转发规则
获取客户端真实IP
数据分析与日志服务
日志服务
数据分析
告警服务
站点与计费管理
计费管理
站点管理
版本管理
通用策略
通用参考
配置语法
请求与响应行为
国家/地区及对应代码枚举
Terraform
Terraform 简介
安装和配置 Terraform
实践教程
EdgeOne Skill 使用指南
自动预热/清除缓存
防盗刷/盗链实践
HTTPS 相关实践
加速优化
流量调度
数据分析与告警
第三方日志平台集成实践
对象存储类源站(例如:COS)配置实践
跨域响应配置
API 文档
History
Introduction
API Category
Making API Requests
Site APIs
Acceleration Domain Management APIs
Site Acceleration Configuration APIs
Edge Function APIs
Alias Domain APIs
Security Configuration APIs
Layer 4 Application Proxy APIs
Content Management APIs
Data Analysis APIs
Log Service APIs
Billing APIs
Certificate APIs
Origin Protection APIs
Load Balancing APIs
Diagnostic Tool APIs
Custom Response Page APIs
API Security APIs
DNS Record APIs
Content Identifier APIs
Legacy APIs
Ownership APIs
Image and Video Processing APIs
Multi-Channel Security Gateway APIs
Version Management APIs
Data Types
Error Codes
常见问题
产品特性相关问题
DNS 记录相关问题
域名配置相关问题
站点加速相关问题
数据与日志相关问题
安全防护相关问题
源站配置相关问题
排障指南
异常状态码参考
EdgeOne 4XX/5XX 状态码排障指南
520/524状态码排障指南
521/522 状态码排障指南
工具指南
相关协议
Service Level Agreement
源站防护启用特别约定
TEO 政策
隐私协议
数据处理和安全协议
联系我们
词汇表

ReadableStream

PDF
聚焦模式
字号
最后更新时间: 2023-02-07 17:59:18
ReadableStream 可读流,也称为可读端,基于 Web APIs 标准 ReadableStream 进行设计。
注意:
不支持直接构造 ReadableStream 对象,使用 TransformStream 构造得到。

描述

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

属性

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

方法

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

getReader

readable.getReader(options?: ReaderOptions): ReadableStreamDefaultReader | ReadableStreamBYOBReader;
创建一个 Reader, 并锁定当前流,直至 Reader 调用 releaseLock() 释放锁。

参数

参数名称
类型
必填
说明
options
生成 Reader 的配置项。

ReaderOptions

ReaderOptions 对象属性如下所示。
属性名
类型
必填
说明
mode
string
Reader 类型,默认值为 undefined,取值说明如下。
undefined
创建 ReadableStreamDefaultReader 类型的 Reader。
byob
创建 ReadableStreamBYOBReader 类型的 Reader。

pipeThrough

readable.pipeThrough(transfromStream: TransfromStream, options?: PipeToOptions): ReadableStream;
流的管道处理。将当前可读流数据传输到参数 transfromStream 的 writable 端,并返回 transfromStream 的 readable 端。
注意:
在管道传输过程中,会对当前流 writable 端进行锁定。

参数

参数名称
类型
必填
说明
transfromStream
当前流传输到的目标对象。
options
流处理配置项。

PipeToOptions

流处理配置项如下所示:
属性名
类型
必填
说明
preventClose
boolean
取值 true 时,表示可读流的关闭,不会导致可写流关闭。
preventAbort
boolean
取值 true 时,表示可读流发生错误,不会导致可写流中止。
preventCancel
boolean
取值 true 时,表示可写流的错误,不会导致结束可读流。
signal
当 `signal` 被 abort 时,将会中止正在进行的传输。

pipeTo

readable.pipeTo(destination: WritableStream, options?: PipeToOptions): Promise<void>;
流的管道处理,将当前可读流传输到 destination 可写流。
注意:
在管道传输过程中,会对当前流 destination 进行锁定。

参数

参数名称
类型
必填
说明
destination
可写流。
options
流处理配置项。

tee

readable.tee(): [ReadableStream, ReadableStream];
将当前流派发出两个独立的可读流。

cancel

readable.cancel(reason?: string): Promise<string>;
结束当前流。

相关参考

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈