Locks.mode
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
// 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