Locks: name プロパティ
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2022年3月以降、すべてのブラウザーで利用可能です。
Lock インターフェイスの読み取り専用プロパティ name は、ロックの要求時に決め、LockManager.request に渡された 名前 を返します。
ロックの名前は、ロックの要求時にスクリプトから渡されます。名前は、オリジン内で、複数のタブ、ワーカー、もしくはその他のコードが協調して用いる抽象リソースを表すよう、開発者が設定します。たとえば、ウェブアプリケーションの 1 個のタブだけがオフラインデータベースとネットワークリソースを同期してほしいときは、"net_db_sync" などのロック名を用いることができます。
値
文字列です。
例
以下の例では、LockManager.request() の呼び出し時にプロパティ name がどのように渡されるかを示します。LockManager は navigator.locks が返すオブジェクトです。
js
navigator.locks.request("net_db_sync", show_lock_properties);
function show_lock_properties(lock) {
console.log(`ロック名: ${lock.name}`);
console.log(`ロックモード: ${lock.mode}`);
}
仕様書
| 仕様書 |
|---|
| Web Locks API # dom-lock-name |