WakeLockSentinel.type

Draft: This page is not complete.

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

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
type
84
84
No
No
Yes
No
84
84
No
Yes
No
14.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/WakeLockSentinel/type