title | short-title | slug | page-type | status | browser-compat | |
---|---|---|---|---|---|---|
IdleDetector: start() method |
start() |
Web/API/IdleDetector/start |
web-api-instance-method |
|
api.IdleDetector.start |
{{securecontext_header}}{{APIRef("Idle Detection API")}}{{SeeCompatTable}}
The start()
method of the {{domxref("IdleDetector")}} interface returns a
{{jsxref("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.
start()
start(options)
options
{{optional_inline}}- : An object with the following properties:
threshold
- : The minimum number of idle milliseconds before reporting should begin.
signal
- : A reference to an {{domxref('AbortSignal')}} instance allowing you to abort idle detection.
- : An object with the following properties:
A {{jsxref("Promise")}}.
NotAllowedError
{{domxref("DOMException")}}- : Use of this feature was blocked by a Permissions Policy.
The following example shows how to start idle detection using the options
argument. It retrieves an instance of AbortSignal
from an instance of {{domxref("AbortController")}}.
const controller = new AbortController();
const signal = controller.signal;
await idleDetector.start({
threshold: 60_000,
signal,
});
console.log("IdleDetector is active.");
{{Specifications}}
{{Compat}}