LockManager.query()

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

The query() method of the LockManager interface returns a Promise that resolves with an object containing information about held and pending locks.

Syntax

query()

Parameters

None.

Return value

A Promise that resolves with an object containing a snapshot of the LockManager state. The object has the following properties:

held: An array of Lock objects for held locks.
pending: An array of Lock objects for pending lock requests.

Exceptions

This method may return a promise rejected with a DOMException of one of the following types:

InvalidStateError DOMException: If the environments document is not fully active.
SecurityError DOMException: If a lock manager cannot be obtained for the current environment.

Examples

const state = await navigator.locks.query();
for (const lock of state.held) {
  console.log(`held lock: name ${lock.name}, mode ${lock.mode}`);
}
for (const request of state.pending) {
  console.log(`requested lock: name ${request.name}, mode ${request.mode}`);
}

Specifications

Specification
Web Locks API # api-lock-manager-query

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
`query`	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/LockManager/query

Name	Web APIs
Version
Badge
Last Updated	2022-04-27T09:33:08Z