Lock.name

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 given by script when the lock is requested. The name is selected by the developer to represent some 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 compatibilityUpdate compatibility data on GitHub