Back to Content

Lock: name property

files/en-us/web/api/lock/name/index.md

latest1.1 KB
Original Source

{{APIRef("Web Locks API")}}{{securecontext_header}} {{AvailableInWorkers}}

The name read-only property of the {{domxref("Lock")}} interface returns the name passed to {{domxref('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".

Value

A string.

Examples

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

js
navigator.locks.request("net_db_sync", showLockProperties);

function showLockProperties(lock) {
  console.log(`The lock name is: ${lock.name}`);
  console.log(`The lock mode is: ${lock.mode}`);
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}