Lock
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2022.
Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.
Note: This feature is available inWeb Workers.
TheLock interface of theWeb Locks API provides the name and mode of a lock.This may be a newly requested lock that is received in the callback toLockManager.request(), or a record of an active or queued lock returned byLockManager.query().
Instance properties
Lock.modeRead onlyReturns the access mode passed to
LockManager.request()when the lock was requested.The mode is either"exclusive"(the default) or"shared".Lock.nameRead onlyReturns the name passed to
LockManager.request()when the lock was requested.
Examples
The following examples show how the mode and name properties are passed in the call toLockManager.request().LockManager is the object returned bynavigator.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
| Specification |
|---|
| Web Locks API # api-lock |