ReadableStreamDefaultReader: releaseLock() メソッド

releaseLock()ReadableStreamDefaultReader インターフェイスのメソッドで、ストリームのリーダーのロックを解除します。

ロックを解除したときに関連するストリームにエラーが発生した場合、リーダーはその後同様にエラーが発生したようになります。 そうでない場合、リーダーは閉じた状態になります。

リーダーのロックは、保留中の読み取りリクエストが残っている間、つまり、リーダーの ReadableStreamDefaultReader.read() メソッドによって返されたプロミスが終了していない場合、解除できません。 これにより、TypeError が発生します。

構文

js
releaseLock()

引数

なし。

返値

なし (undefined)。

例外

TypeError

ソースオブジェクトが ReadableStreamDefaultReader でないか、読み取り要求が保留中です。

js
function fetchStream() {
  const reader = stream.getReader();

  // ...

  reader.releaseLock();

  // ...
}

仕様書

Specification
Streams Standard
# ref-for-default-reader-release-lock②

ブラウザーの互換性

BCD tables only load in the browser

関連情報