WakeLock.request()

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The request() method of the WakeLock interface returns a Promise that resolves with a WakeLockSentinel object, which allows control over screen dimming and locking.

Syntax

var wakeLock = navigator.wakeLock.request(type);

Parameters

type

Options are as follows:

  • 'screen': Requests a screen wake lock. Prevents devices from dimming or locking the screen.

Return value

A Promise that resolves with a WakeLockSentinel object.

Exceptions

NotAllowedError

Thrown when wake lock is not available, which can happen because:

  • Document is not allowed to use screen wake lock due to screen-wake-lock policy.
  • Document is not fully active.
  • Document is hidden.
  • User Agent could not acquire platform's wake lock.

Examples

The following asynchronous function requests a WakeLockSentinel object. The request() method is wrapped in a try...catch statement to account for if the browser refuses the request for any reason. 

const requestWakeLock = async () => {
  try {

    const wakeLock = await navigator.wakeLock.request('screen');

  } catch (err) {
    // The wake lock request fails - usually system-related, such as low battery.

    console.log(`${err.name}, ${err.message}`);
  }
}

requestWakeLock();

Specifications

Specification
Screen Wake Lock API
# the-request-method

Browser compatibility

BCD tables only load in the browser

See also