away

detect idle users on webpages


``js
var away = require('away');

// detect users who are idle for 10 seconds
var timer = away(10000);
timer.on('idle', function() {
console.log('user is idle');
});
timer.on('active', function() {
console.log('user is active');
});
`

api

`away()` returns a Timer object which exposes the following methods.

$3


Call `fn` when user becomes idle.

$3

Call `fn` when user becomes active after having been idle.

$3

Stop the idle timer from detecting user activity

$3

Start the idle timer. (By default the idle timer is started automatically)

options

`idle()` accepts a second argument with additional options.

$3


The dom element to monitor for activity. (default `document`)

$3

Milliseconds before user is considered idle. (default `30000`)

$3

String of DOM events that will trigger activity. (see index.js for default)

$3

Whether to start idle timer upon creation. (default `true`)

install

`
npm isnstall away
``

credits

Inspired by the jquery-idletimer plugin.