--- title: Navigator.requestWakeLock() slug: Archive/B2G_OS/API/Navigator/requestWakeLock translation_of: Archive/B2G_OS/API/Navigator/requestWakeLock ---

{{APIRef("Wake Lock API")}}{{ non-standard_header() }}

This Navigator.requestWakeLock() method of the Wake Lock API is used to request a {{ domxref("MozWakeLock") }} on any resource of the device. This means that you can prevent that resource from becoming unavailable as long as your app holds a lock for that resource. For example, a voice recording app can obtain a lock to keep the screen on during recording so that it can give prover visual feedback to the user that recording is progressing.

Note: When the window that requested one or more wake locks is closed or destroyed, any wake locks it acquired are implicitly released; no manual release is necessary.

Syntax

lock = window.navigator.requestWakeLock(resourceName);

Parameters

resourceName
A string representing the name of the resource to lock. Gaia uses four basic resources names: screen, cpuwifi, and gps, but any certified application can expose new resources.

Return value

Returns a {{domxref("MozWakeLock")}} object you can use to keep track of or release the lock..

Specification

W3C tracks Wake Lock: Use cases and is working on the Editor's traft API.

See also