NodeJS Event Based System Time Keeper
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
src
test
.gitignore
.travis.yml
README.md
package.json

README.md

Build Status Coverage Status

systime

NodeJS Event Based System Time Keeper

Systime syncs with system time and emits time events. It accounts for fluctuations in time accuracy by continuously re-syncing with local system time.

Use this package for any software that needs to accurately track time (assuming system time is accurate).

For more information on computer clocks and time see NTP.org.

Requirements

  • NodeJS v5.11.x or higher
  • NPM

See ./package.json

Installation

Source available on GitHub or install module via NPM:

$ npm install systime

Usage

After requiring systime create a new instance. Bind event listeners to systime then call the start method.

var Systime = require('systime')

var systime = new Systime()

// bind listeners to zero or more of the following events
// (each callback has a date object argument)

systime.on('second', date => console.log(date))

systime.on('minute', () => console.log('new minute'))

systime.on('hour', () => console.log('new hour'))

systime.on('day', () => console.log('new day'))

systime.on('week', () => console.log('new week'))

systime.on('month', () => console.log('new month'))

systime.on('year', () => console.log('new year'))

systime.start() // start systime

// runs until process has exited or systime.stop() method called

The above starts systime and console logs as event listeners are triggered.

See ./example/events.js for working example.

That's it!

License

MIT