Locks.name

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

The name read-only property of the Lock interface returns the name passed to LockManager.request selected when the lock was requested.

The name of a lock is passed by script when the lock is requested. The name is selected by the developer to represent an abstract resource for which use is being coordinated across multiple tabs, workers, or other code within the origin. For example, if only one tab of a web application should be synchronizing network resources with an offline database, it could use a lock name such as "net_db_sync".

Syntax

var name = Lock.name

Value

A DOMString.

Example

The following examples show how the name property passed in the call to LockManager.request(). LockManager is the object returned by navigator.locks.

navigator.locks.request("net_db_sync", 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

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
name
69
79
No
No
56
No
69
69
No
48
No
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/name