LockManager: query() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2022.

LockManager インターフェイスの query() メソッドは、確保中のロックと獲得待ち中のロックに関する情報を持ったオブジェクトで解決する Promise を返します。

構文

js
query()

引数

なし

返値

LockManager の状態のスナップショットを持ったオブジェクトで解決する Promise を返します。このオブジェクトは以下のプロパティを持ちます。

  • held: 確保中のロックに関する LockInfo オブジェクトの配列です。
  • pending: 獲得待ち中のロックに関する LockInfo オブジェクトの配列です。

例外

このメソッドは、以下のいずれかの種類の DOMException で拒否される Promise を返す可能性があります。

InvalidStateError DOMException

ドキュメントが完全にアクティブでない環境のとき投げられます。

SecurityError DOMException

現在の環境でロックマネージャーが取得できないとき投げられます。

例

js
const state = await navigator.locks.query();
for (const lock of state.held) {
  console.log(`確保中のロック: 名前 ${lock.name}, モード ${lock.mode}`);
}
for (const request of state.pending) {
  console.log(`要求中のロック: 名前 ${request.name}, モード ${request.mode}`);
}

仕様書

Specification
Web Locks API
# api-lock-manager-query

ブラウザーの互換性

BCD tables only load in the browser