annexare / idledetect

A TypeScript library for inactivity timer, which utilises `IdleDetector` API where possible or a fallback to `window.setTimeout` approach.

Idle Detect

A TypeScript library for inactivity timer, which utilises IdleDetector API where possible or a fallback to window.setTimeout approach.

Usage

npm install idle-detect

import IdleDetect from 'idle-detect'
// Or, if you don't want to use still experimental IdleDetector API:
// import { IdleDetect } from 'idle-detect/dist/IdleDetect'

const onInactive = () => {
  console.info('User is inactive now')
}
const idleDetect = new IdleDetect(15 * 60, onInactive)

// Start timer, e.g. when user is logged in
idleDetect.start()

// End timer, e.g. when user is logged out
idleDetect.cleanupAndStop()

idledetect's Issues

UserIdleState is not defined at IdleDetectIsomorph.handleIdleChange

Hi :)

I have an issue when I run this module.
UserIdleState is not declared in any code. but the module uses the UserIdleState
How can I fix this error?

Thank you in advacne

IdleDetectIsomorph.js:39 Uncaught TypeError: (intermediate value).cleanupAndStop is not a function

When I block permission after 5 seconds and a timer times out, I got the error

setTimeoutConnection = async () => { 
  this.timeout = setTimeout(
      this.onInactive,
      CONNECTION_TIMEOUT
    )
  try {
    const idleDetect = new IdleDetect(
      CONNECTION_TIMEOUT / 1000, // Unit: Second
      this.onInactive
    )
    idleDetect.start()
    if ((await window.IdleDetector.requestPermission()) === 'granted') {
      if (this.timeout) {
        clearTimeout(this.timeout)
      }
    }
  } catch {
    // Ignore errors
  }
}

Chrome: Version 104.0.5112.101
Ubuntu: 20.04

It doesn't catch `screenState` on Ubuntu

It doesn't run this.handle() when I lock my screen

if (userState === UserIdleState.idle || screenState === ScreenIdleState.locked) {
    this.handleIdle();
}

OS: Ubuntu 20.04.4 LTS

Did you test it?