Lock

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.

Web Locks API の Lock インターフェイスは、ロックの名前とモードを提供します。これは LockManager.request() のコールバックが受け取る新しく要求されたロックのことも、LockManager.query() が返した動作中もしくは待機中のロックの記録のこともあります。

インスタンスプロパティ

Lock.mode 読取専用

ロックの要求時に LockManager.request() に渡されたアクセスモードを返します。モードは "exclusive" (デフォルト) か "shared" のいずれかです。

Lock.name 読取専用

ロックの要求時に LockManager.request() に渡された名前を返します。

例

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

js
navigator.locks.request("net_db_sync", show_lock_properties);
navigator.locks.request(
  "another_lock",
  { mode: "shared" },
  show_lock_properties,
);

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

仕様書

Specification
Web Locks API
# api-lock

ブラウザーの互換性

BCD tables only load in the browser