Lock: name property
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 in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
The name read-only property of
the Lock interface returns the name passed to
LockManager.request selected when the lock was requested.
The name of a lock is passed by script when the lock is requested. The name is selected
by the developer to represent an abstract resource for which use is being coordinated
across multiple tabs, workers, or other code within the origin. For example, if only one
tab of a web application should be synchronizing network resources with an offline
database, it could use a lock name such as "net_db_sync".
Value
A string.
Examples
The following examples show how the name property passed in the call
to LockManager.request(). LockManager is the object returned
by navigator.locks.
navigator.locks.request("net_db_sync", 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 # dom-lock-name |
Browser compatibility
| desktop | mobile | server | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support