Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1006 Bytes

File metadata and controls

41 lines (29 loc) · 1006 Bytes
title slug page-type status browser-compat
WakeLockSentinel.type
Web/API/WakeLockSentinel/type
web-api-instance-property
experimental
api.WakeLockSentinel.type

{{APIRef("Screen Wake Lock API")}}{{SecureContext_Header}}{{SeeCompatTable}}

The read-only type property of the {{domxref("WakeLockSentinel")}} interface returns a string representation of the currently acquired {{domxref("WakeLockSentinel")}} type.

Value

A string representation of the currently acquired wake lock type. The type 'screen'` is a screen wake lock. It prevents devices from dimming or locking the screen.

Examples

This example shows an asynchronous function that acquires a {{domxref("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

{{Specifications}}

Browser compatibility

{{Compat}}