dom / latest / lock.html /

Lock

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The Lock interface of the Web Locks API provides the name and mode of a lock. This may be a newly requested lock that is received in the callback to LockManager.request(), or a record of an active or queued lock returned by LockManager.query().

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
Web Locks API
# api-lock

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
Lock
69
79
96
93-96
No
56
15.4
69
69
96
48
15.4
10.0
mode
69
79
96
93-96
No
56
15.4
69
69
96
48
15.4
10.0
name
69
79
96
93-96
No
56
15.4
69
69
96
48
15.4
10.0

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Lock