WakeLockSentinel: type property
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The type
read-only property of the WakeLockSentinel
interface returns a string representation of the currently acquired WakeLockSentinel
type.
Value
A string representation of the currently acquired wake lock type.
Currently, the value is always screen
, which represents a screen wake lock.
It prevents devices from dimming or locking the screen.
Examples
This example shows an asynchronous function that acquires a WakeLockSentinel
, then logs the type to the console.
js
const requestWakeLock = async () => {
wakeLock = await navigator.wakeLock.request("screen");
console.log(wakeLock.type); // logs 'screen'
};
requestWakeLock();
Specifications
Specification |
---|
Screen Wake Lock API # the-type-attribute |
Browser compatibility
BCD tables only load in the browser