Locks: name プロパティ

Baseline 2022

Newly available

Since March 2022, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Lock インターフェイスの読み取り専用プロパティ name は、ロックの要求時に決め、LockManager.request に渡された名前を返します。

ロックの名前は、ロックの要求時にスクリプトから渡されます。名前は、オリジン内で、複数のタブ、ワーカー、もしくはその他のコードが協調して用いる抽象リソースを表すよう、開発者が設定します。たとえば、ウェブアプリケーションの 1 個のタブだけがオフラインデータベースとネットワークリソースを同期してほしいときは、"net_db_sync" などのロック名を用いることができます。

値

文字列です。

例

以下の例では、LockManager.request() の呼び出し時にプロパティ name がどのように渡されるかを示します。LockManager は navigator.locks が返すオブジェクトです。

navigator.locks.request("net_db_sync", show_lock_properties);

function show_lock_properties(lock) {
  console.log(`ロック名: ${lock.name}`);
  console.log(`ロックモード: ${lock.mode}`);
}

仕様書

Specification
Web Locks API # dom-lock-name

ブラウザーの互換性

BCD tables only load in the browser