1. module node-cron
   1. function node-cron.schedule (expression, func, immediateStart)
   2. function node-cron.scheduled_task (task, immediateStart)
   3. function node-cron.task (pattern, execution)
   4. object node-cron.scheduled_task.prototype
   5. object node-cron.task.prototype
2. module node-cron.scheduled_task
   1. function node-cron.scheduled_task (task, immediateStart)
3. module node-cron.scheduled_task.prototype
   1. function node-cron.scheduled_task.prototype.destroy ()
   2. function node-cron.scheduled_task.prototype.start ()
   3. function node-cron.scheduled_task.prototype.stop ()
4. module node-cron.task
   1. function node-cron.task (pattern, execution)
5. module node-cron.task.prototype
   1. function node-cron.task.prototype.update (date)

module node-cron

function node-cron.schedule (expression, func, immediateStart)

• description and source-code

  function createTask(expression, func, immediateStart) {
    var task = new Task(expression, func);
  
    return new ScheduledTask(task, immediateStart);
  }

• example usage

  ...
  ```
  
  Import node-cron and schedule a task:
  
  ```javascript
  var cron = require('node-cron');
  
  cron.schedule('* * * * *', function(){
    console.log('running a task every minute');
  });
  ```
  
  ## Cron Syntax
  
  This is a quick reference to cron syntax and also shows the options supported by node-cron.
  ...

function node-cron.scheduled_task (task, immediateStart)

• description and source-code

  function ScheduledTask(task, immediateStart) {
    this.task = function() {
      task.update(new Date());
    };
  
    this.tick = null;
  
    if (immediateStart !== false) {
      this.start();
    }
  }

• example usage

  n/a

function node-cron.task (pattern, execution)

• description and source-code

  function Task(pattern, execution){
    validatePattern(pattern);
    this.initialPattern = pattern.split(' ');
    this.pattern = convertExpression(pattern);
    this.execution = execution;
    this.expressions = this.pattern.split(' ');
  }

• example usage

  n/a

module node-cron.scheduled_task

function node-cron.scheduled_task (task, immediateStart)

• description and source-code

  function ScheduledTask(task, immediateStart) {
    this.task = function() {
      task.update(new Date());
    };
  
    this.tick = null;
  
    if (immediateStart !== false) {
      this.start();
    }
  }

• example usage

  n/a

module node-cron.scheduled_task.prototype

function node-cron.scheduled_task.prototype.destroy ()

• description and source-code

  destroy = function () {
    this.stop();
  
    this.task = null;
  }

• example usage

  ...
  ```javascript
  var cron = require('node-cron');
  
  var task = cron.schedule('* * * * *', function() {
    console.log('will not execute anymore, nor be able to restart');
  });
  
  task.destroy();
  ```
  
  ## Issues
  
  Feel free to submit issues and enhancement requests [here](https://github.com/merencia/node-cron/issues).
  
  ## Contributors
  ...

function node-cron.scheduled_task.prototype.start ()

• description and source-code

  start = function () {
    if (this.task && !this.tick) {
      this.tick = setInterval(this.task, 1000);
    }
  
    return this;
  }

• example usage

  ...
  ```javascript
  var cron = require('node-cron');
  
  var task = cron.schedule('* * * * *', function() {
    console.log('immediately started');
  }, false);
  
  task.start();
  ```
  
  ### Stop
  
  The task won't be executed unless re-started.
  
  ```javascript
  ...

function node-cron.scheduled_task.prototype.stop ()

• description and source-code

  stop = function () {
    if (this.tick) {
      clearInterval(this.tick);
      this.tick = null;
    }
  
    return this;
  }

• example usage

  ...
  ```javascript
  var cron = require('node-cron');
  
  var task = cron.schedule('* * * * *', function() {
    console.log('will execute every minute until stopped');
  });
  
  task.stop();
  ```
  
  ### Destroy
  
  The task will be stopped and completely destroyed.
  
  ```javascript
  ...

module node-cron.task

function node-cron.task (pattern, execution)

• description and source-code

  function Task(pattern, execution){
    validatePattern(pattern);
    this.initialPattern = pattern.split(' ');
    this.pattern = convertExpression(pattern);
    this.execution = execution;
    this.expressions = this.pattern.split(' ');
  }

• example usage

  n/a

module node-cron.task.prototype

function node-cron.task.prototype.update (date)

• description and source-code

  update = function (date){
    if(mustRun(this, date)){
      try {
        this.execution();
      } catch(err) {
        console.error(err);
      }
    }
  }

• example usage

  ...
     * Creates a new scheduled task.
     *
     * @param {Task} task - task to schedule.
     * @param {boolean} immediateStart - whether to start the task immediately.
     */
    function ScheduledTask(task, immediateStart) {
  this.task = function() {
    task.update(new Date());
  };
  
  this.tick = null;
  
  if (immediateStart !== false) {
    this.start();
  }
  ...