node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

needle-schedule

node-needle-schedule

Schedule needle requests.

node-needle-schedule

npm version Build Status Dependency Status devDependency Status

Schedule needle-retry requests using node-schedule.

Installation

npm install needle-schedule

Usage

var needleSchedule = require('needle-schedule');
var ns = needleSchedule(targets, options);
ns.on('response', function(response) {
  console.log(response);
});
ns.start();
ns.stop();

Parameters

Targets

The first parameter required by the setup function is an array of targets. An example:

[
  {
    'url': 'https://github.com',
    'rule': { second: [15, 35, 55] }
  }
]

url is the only required parameter. rule is the schedule rule for node-schedule. In this case, 3 times a minute when second equals any of the three values (defaults to second: 1, e.g. once a minute). needleRetry options passed on to needle-retry.

If no other options than url are set in the target, the defaults provided by the options parameter, explained below, will be used.

Options

Options can be passed in as the second parameter. It can contain the default values for targets. For instance the defaults:

var options = {
    'method': 'get',
    'data': null,
    'needleRetry': null,
    'rule': { 'second': 1 }
}

These options will be applied to all targets that do not explicitly define them themselves. Note that if no rule is provided, it defaults to second: 1, e.g. once a minute.

events

This module is an event emitter, that will emit events on start, stop, run, end and results. The results event will emit:

  1. response - the response from needle-retry.
  2. body - the raw body from needle-retry.
  3. options - the options (and target) the results have been collected with.
  4. timestamps - timestamps (start and end) of the request.

Example

var needleSchedule = require('needle-schedule');
 
// declare google.com a target 
var targets = [
  {
    'url': 'https://google.com'
  }
];
 
// set up the schedule 
var ns = needleSchedule(targets).start();
 
// receive the response 
ns.on('response', function(response) {
  console.log(response);
});

Advanced example

var needleSchedule = require('needle-schedule');
 
// first will use default options below, second has custom options 
var targets = [
  {
    'url': 'https://google.com'
  },
  {
    'url': 'https://github.com',
    'rule': { 'second': [15, 35, 55] }
  }
];
 
// default options 
var options = {
  'rule': { 'second': [1, 10, 20, 30, 40, 50] }
};
 
// set up the schedule 
var ns = needleSchedule(targets, options);
 
// receive the response 
ns.on('response', function(response) {
  console.log(response);
});
 
// start the schedule 
ns.start();
 
// stop the schedule after 60 seconds 
setTimeout(function() {
  ns.stop();
}, 60000);