API Docs for:
Show:

Alarm Class

Defined in: lib/alarm.js:7

AlarmJS, an alaram clock for Node.js and the command line.

Constructor

Alarm

(
  • config
)
Object public

Defined in lib/alarm.js:7

Parameters:

  • config Object

    A config object

    • [file=asset/alarm.mp3] String optional

      A path to a MP3 file to be player

    • hour Number

      The hour when the alarm will go on

    • [minutes=0] Number optional

      The minutes where the alarm will go on

    • [seconds=0] Number optional

      The seconds where the alarm will go on

Returns:

Object:

An event emitter

Example:

var alarm = require('alarmjs');
var a = new alarm({
    file : 'musics/AC_DC/TNT.mp3',
    hour : 8,
    minutes : 34,
    seconds : 30
});

Item Index