Package Exports

inactivity-timer

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (inactivity-timer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Inactivity Timer

Run a function after a period of inactivity.

Installation

npm install --save inactivity-timer

Usage

const createInactivityTimer = require('inactivity-timer')

// Lock the screen after 5 min of idle
const lockTimer = createInactivityTimer('5m', () => {
  // Lock the screen!
})

// Signal activity when the mouse moves
document.addEventListener('mousemove', () => {
  lockTimer.signal()
})

API

`createInactivityTimer(threshold, onInactivity) => InactivityTimer`

Create a new InactivityTimer.

threshold can be specied as either a number, in milliseconds, or any string that the ms module can parse.

`InactivityTimer#clear()`

Clear any timer currently scheduled.

`InactivityTimer#signal()`

Signal activity, which will extend the time until onInactivity is called with the earlier specified threshold.