WakeLockSentinel.type
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The read-only type
property of the
WakeLockSentinel
interface returns a string
representation of the currently acquired WakeLockSentinel
type.
Syntax
var type = sentinel.type;
Value
A string representation of the currently acquired wake lock type.
- type Read only
-
Return values are:
-
'screen'
: A screen wake lock. 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.
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