Options
All
  • Public
  • Public/Protected
  • All
Menu

Optional settings that can be specified when creating an idle timer.

Hierarchy

  • IdleTimerOptions

Index

Properties

events: string

List of events that constitute an activity by the user. Defaults to

mousemove keydown wheel DOMMouseScroll mousewheel mousedown touchstart touchmove MSPointerDown MSPointerMove
idle: boolean

Indicates if the user is currently idle. Defaults to false.

timeout: number

The timeout period in milliseconds. Defaults to 30000.

timerSyncId: string

If set, the use a local storage key to sync activity across browser tabs or windows.

Generated using TypeDoc