https://github.com/boobsd/reminder

Simple scheduler for Node.JS
https://github.com/boobsd/reminder

Last synced: about 2 months ago
JSON representation

Simple scheduler for Node.JS

• Host: GitHub
• URL: https://github.com/boobsd/reminder
• Owner: BooBSD
• Created: 2012-08-26T10:23:44.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-08-29T06:52:19.000Z (over 12 years ago)
• Last Synced: 2024-10-29T01:15:28.801Z (2 months ago)
• Language: JavaScript
• Size: 89.8 KB
• Stars: 12
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
========

Reminder

========

Simple scheduler for Node.JS

Installation

============

To install Reminder please run the following command::

    $ npm install reminder

Usage

=====

Quick start

-----------

Initializing the reminder::

    var Reminder = require('reminder');

    var remind = new Reminder();

And handy helper::

    var util = require('util');

Adding the few tasks::

    remind.every('5 minutes', function(date) {

        util.log("Close the Twitter and start to work!");

    });

    remind.every('4 hours', function(date) {

        util.log("It\'s time to eat something!");

    });

Also you may add the task that should be done only once::

    remind.at('07:45', function(date) {

        util.log("Wake up! You have an interview at 9 AM.")

    });

Events

------

* 'minute'

* '2 minutes'

* '3 minutes'

* '4 minutes'

* '5 minutes'

* '6 minutes'

* '10 minutes'

* '12 minutes'

* '15 minutes'

* '20 minutes'

* '30 minutes'

* 'hour'

* '2 hours'

* '3 hours'

* '4 hours'

* '6 hours'

* '8 hours'

* '12 hours'

Methods

-------

* remind.at

* remind.every

* remind.cancel

* remind.forget