dom / latest / idledetector / start.html /

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

start()
start(options)

Parameters

options Optional

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 idle 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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
start
94
94
No
No
80
No
94
94
No
66
No
17.0

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/IdleDetector/start