This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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"
.
Syntax
var name = Lock.name
Value
A DOMString
.
Example
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", show_lock_properties); function show_lock_properties(lock) { console.log(`The lock name is: ${lock.name}`); console.log(`The lock mode is: ${lock.mode}`); }
Specifications
Specification | Status | Comment |
---|---|---|
Web Locks API The definition of 'name' in that specification. |
Draft | Initial definition. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
name | Chrome Full support 69 | Edge Full support ≤79 | Firefox ? | IE ? | Opera Full support 56 | Safari ? | WebView Android Full support 69 | Chrome Android Full support 69 | Firefox Android ? | Opera Android Full support 48 | Safari iOS ? | Samsung Internet Android Full support 10.0 |
Legend
- Full support
- Full support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.