Lock: mode 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 mode read-only property of the Lock interface returns the access mode passed to LockManager.request() when the lock was requested.
The mode is either "exclusive" (the default) or "shared".
Value
One of "exclusive" or "shared".
Examples
The following examples show how the mode property is passed in the call to LockManager.request().
LockManager is the object returned by navigator.locks.
js
// Should show "exclusive" (the default)
navigator.locks.request("my_resource", showLockProperties);
// Should show "exclusive"
navigator.locks.request(
"my_resource",
{ mode: "exclusive" },
showLockProperties,
);
// Should show "shared"
navigator.locks.request("my_resource", { 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 # dom-lock-mode |
Browser compatibility
| desktop | mobile | server | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
mode
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support