ReadableStreamBYOBReader:releaseLock() 方法

注意: 此功能在 Web Workers 中可用。

releaseLock()ReadableStreamBYOBReader 接口的方法,它释放读取器对流的锁定。释放锁定后,读取器将不再处于活动状态。

如果释放锁定时关联的流出错,则读取器将显示出错;否则,读取器将显示已关闭。

如果读取器在仍有待处理的读取请求的情况下释放其锁定,则读取器的 ReadableStreamBYOBReader.read() 方法返回的 Promise 将立即被 TypeError 拒绝。未读取的块将保留在流的内部队列中,以后可以通过获取新的读取器来读取。

语法

js
releaseLock()

参数

无。

返回值

无 (undefined).

异常

TypeError

如果源对象不是 ReadableStreamBYOBReader,则抛出此异常。

示例

下面显示了一个简单的示例。锁定在读取器在流上创建时立即创建。

js
const reader = stream.getReader({ mode: "byob" });
reader.releaseLock();

规范

规范
Streams 标准
# ref-for-byob-reader-release-lock②

浏览器兼容性

BCD 表格仅在浏览器中加载

另请参阅