This is an experimental technology
Check 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().


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.

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}`);


Specification Status Comment
Web Locks API
The definition of 'Lock' in that specification.
Draft Initial definition.

Browser compatibilityUpdate compatibility data on GitHub

Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 69 ? ? ? 56 ?
mode 69 ? ? ? 56 ?
name 69 ? ? ? 56 ?
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support 69 69 ? ? 56 ? ?
mode 69 69 ? ? 56 ? ?
name 69 69 ? ? 56 ? ?

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.