LockManager: query() method
The query()
method of the LockManager
interface returns a Promise
that resolves with an object containing information about held and pending locks.
Syntax
js
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:
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
js
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
BCD tables only load in the browser