throttled-request/lib/index.js

Node.js module to easily throttle HTTP requests

/*
ThrottledRequest module.

Usage
====================================
var request = require("request"); //https://github.com/request/request
request.defaults(options);

//Instantiate a new `throttledRequest`.
//Pass along a `request` instance to be used
var throttledRequest = require("./throttled-request")(request);

//Configure 10 requests per second
throttledRequest.configure({
  requests: 10,
  milliseconds: 1000
});

//Now you can use `throttledRequest` just as you use https://github.com/request/request
//Using callback
throttledRequest(options, function (error, response, body) {
  //...
});
//Or as a stream
someReadStream.pipe(throttledRequest(options)).pipe(someWriteStream);
*/
'use strict';

var ThrottledRequest = require("./throttled-request");

module.exports = function (request) {
  if (!request) throw new Error("A request (https://github.com/request/request) instance must be provided");
  return new ThrottledRequest(request);
};