ReadableStreamBYOBReader:releaseLock() 方法

可用性有限

此特性不是基線特性,因為它在一些最廣泛使用的瀏覽器中不起作用。

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

ReadableStreamBYOBReader 介面的 releaseLock() 方法會釋放讀取器對流的鎖定。解鎖後,讀取器將不再處於活動狀態。

如果解鎖時關聯的流發生錯誤,讀取器將顯示錯誤;否則,讀取器將顯示已關閉。

如果在讀取器仍有待處理的讀取請求時釋放了讀取器的鎖定,則讀取器的 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②

瀏覽器相容性

另見