Lock: mode property
Baseline 2022
Newly available
Since March 2022, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
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", show_lock_properties);
// Should show "exclusive"
navigator.locks.request(
"my_resource",
{ mode: "exclusive" },
show_lock_properties,
);
// Should show "shared"
navigator.locks.request(
"my_resource",
{ 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 |
---|
Web Locks API # dom-lock-mode |
Browser compatibility
BCD tables only load in the browser