IdleDetector.start()

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

The start() method of the IdleDetector interface returns a Promise that resolves when the detector starts listening for changes in the user's idle state. This method takes an optional options object with the threshold in milliseconds where inactivity should be reported and signal for an AbortSignal to abort the idle detector.

Syntax

IdleDetector.start();
IdleDetector.start(options);

Parameters

optionsOptional

An object with the following properties:

  • threshold: The minimum number of idle milliseconds before reporting should begin.
  • signal: A reference to an AbortSignal instance allowing you to abort idel detection.

Return Value

A Promise.

Examples

The following example shows how to start idle detection using the options argument. It retrieves an instance of AbortSignal from an instance of AbortController.

const controller = new AbortController();
const signal = controller.signal;

await idleDetector.start({
  threshold: 60_000,
  signal,
});
console.log('IdleDetector is active.');

Specifications

Specification
Idle Detection API
# api-idledetector-start

Browser compatibility

BCD tables only load in the browser