This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.
The Lock
interface of the the Web Locks API provides the name and mode of a previously requested lock, which is received in the callback to LockManager.request()
.
Properties
Lock.mode
Read only- Returns the access mode passed to
LockManager.request()
when the lock was requested. The mode is either"exclusive"
(the default) or"shared"
. Lock.name
Read only- Returns 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 to LockManager.request()
. LockManager
is the object returned by navigator.locks
.
navigator.locks.request("net_db_sync", show_lock_properties);
navigator.locks.request("another_lock", {mode: "shared"}, 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 APIThe definition of 'Lock' in that specification. | Draft | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
Full support 69 |
Edge
Full support ≤79 |
Firefox
? |
IE
No support No |
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 |
Chrome
Full support 69 |
Edge
Full support ≤79 |
Firefox
? |
IE
No support No |
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 | |
Chrome
Full support 69 |
Edge
Full support ≤79 |
Firefox
? |
IE
No support No |
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
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
Lock by Mozilla Contributors is licensed under CC-BY-SA 2.5.