W3cubDocs

/DOM

LockManager.query

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 that contains information about held and pending locks.

Syntax

var promise<LockManagerSnapshot> = LockManager.query()

Parameters

None.

Return value

A Promise that resolves with a LockManagerSnapshot containing the following properties.

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

Example

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 Status Comment
Web Locks API
The definition of 'query()' in that specification.
Draft Initial definition.

Browser compatibilityUpdate compatibility data on GitHub

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

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/LockManager/query