Lock

Secure context Available in workers

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 LockManager.request(), or a record of an active or queued lock returned by query().

Instance properties

• mode Read only
  • : Returns the access mode passed to request() when the lock was requested. The mode is either "exclusive" (the default) or "shared".
• name Read only
  • : Returns the name passed to request() when the lock was requested.

Examples

The following examples show how the mode and name properties are passed in the call to request(). LockManager is the object returned by 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

Browser compatibility