Lock

{{APIRef("Web Locks API")}}{{securecontext_header}} {{AvailableInWorkers}}

The Lock interface of the Web Locks API provides the name and mode of a lock. This may be a newly requested lock that is received in the callback to {{domxref('LockManager.request','LockManager.request()')}}, or a record of an active or queued lock returned by {{domxref('LockManager.query()')}}.

Instance properties

• {{domxref('Lock.mode')}} {{ReadOnlyInline}}
  • : Returns the access mode passed to {{domxref('LockManager.request()')}} when the lock was requested. The mode is either "exclusive" (the default) or "shared".
• {{domxref('Lock.name')}} {{ReadOnlyInline}}
  • : Returns the name passed to {{domxref('LockManager.request()')}} when the lock was requested.

Examples

The following examples show how the mode and name properties are passed in the call to {{domxref('LockManager.request()')}}. {{domxref('LockManager')}} is the object returned by {{domxref('navigator.locks')}}.

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

function showLockProperties(lock) {
  console.log(`The lock name is: ${lock.name}`);
  console.log(`The lock mode is: ${lock.mode}`);
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}