WakeLockSentinel: release() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

The release() method of the WakeLockSentinel interface releases the WakeLockSentinel, returning a Promise that is resolved once the sentinel has been successfully released.

Syntax

js
release()

Parameters

None.

Return value

Returns a Promise that resolves with undefined.

Exceptions

No exceptions are thrown. You should always listen for the release event to check if a wake lock has been released.

Examples

In this example, when a user clicks a button the WakeLockSentinel is released.

js
wakeLockOffButton.addEventListener("click", () => {
  WakeLockSentinel.release();
});

Specifications

Specification
Screen Wake Lock API
# the-release-method

Browser compatibility

BCD tables only load in the browser

See also