IdleManager
Defined in: idleManager.ts:31
Detects if the user has been idle for a duration of idleTimeout ms, and calls onIdle and registered callbacks.
By default, the IdleManager will log a user out after 10 minutes of inactivity.
To override these defaults, you can pass an onIdle callback, or configure a custom idleTimeout in milliseconds
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew IdleManager(options):IdleManager
Defined in: idleManager.ts:76
Parameters
Section titled “Parameters”options
Section titled “options”IdleManagerOptions = {}
Returns
Section titled “Returns”IdleManager
Properties
Section titled “Properties”callbacks
Section titled “callbacks”callbacks:
IdleCB[] =[]
Defined in: idleManager.ts:32
idleTimeout
Section titled “idleTimeout”idleTimeout:
undefined|number
Defined in: idleManager.ts:33
timeoutID?
Section titled “timeoutID?”
optionaltimeoutID:number=undefined
Defined in: idleManager.ts:34
Methods
Section titled “Methods”_resetTimer()
Section titled “_resetTimer()”_resetTimer():
void
Defined in: idleManager.ts:138
Resets the timeouts during cleanup
Returns
Section titled “Returns”void
exit()
Section titled “exit()”exit():
void
Defined in: idleManager.ts:124
Cleans up the idle manager and its listeners
Returns
Section titled “Returns”void
registerCallback()
Section titled “registerCallback()”registerCallback(
callback):void
Defined in: idleManager.ts:117
Parameters
Section titled “Parameters”callback
Section titled “callback”IdleCB
function to be called when user goes idle
Returns
Section titled “Returns”void
create()
Section titled “create()”
staticcreate(options):IdleManager
Defined in: idleManager.ts:45
Creates an IdleManager
Parameters
Section titled “Parameters”options
Section titled “options”Optional configuration
captureScroll?
Section titled “captureScroll?”boolean
capture scroll events
Default
falseidleTimeout?
Section titled “idleTimeout?”number
timeout in ms
Default
10 minutes [600_000]onIdle?
Section titled “onIdle?”() => unknown
Callback after the user has gone idle
See
IdleCB
scrollDebounce?
Section titled “scrollDebounce?”number
scroll debounce time in ms
Default
100Returns
Section titled “Returns”IdleManager