WakeLock: request() method

type

Options are as follows:

'screen'

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

A Promise that resolves with a WakeLockSentinel object.

NotAllowedError

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

• Use of this feature is blocked by a Permissions Policy.
• The document is not fully active.
• The document is hidden.
• The User Agent could not acquire platform's wake lock.

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();

• WakeLock
• Navigator.wakeLock