README.md

qthrottle

Limits concurrency of promise returning functions.

Installation

$ npm install qthrottle

Example

Before

The downloader function will start as many download sessions as it is called.

var downloader = (function() {

	return function(url) {
		// return an promise
	};

})();

After

The new downloader function will start as most 10 download sessions at once.

var downloader = (function() {

	var throttle = require('qthrottle')(10);

	var download = function(url) {
		// return an promise
	};

	return function(url) {
		return throttle.fcall(download, null, url);
	};

})();

Progress example

You can also configure qthrottle to report it's current progress on processing promise queue.

var limit = 10;
var throttle = require('qthrottle')(
    limit,
    function(running, queued) {
        console.log('We are currently processing ' + running + ' promises out of ' + limit + ' possible concurrently. Queue length is ' + queued);
    }
);

Throttlize example

var limit = 10;
var throttle = require('qhtrottle')(limit);

module.exports = throttle.throttlize({
	downloadThis: downloadThis,
	downloadThat: downloadThat
});

API

var throttle = require('qthrottle')(limit, progressFunc)

• limit - concurrency limit

• progressFunc - called with two numeric arguments: function(running, queued)

  var promise = throttle.fcall(func, thisArg, arg1, arg2, ...)

• promise - an Q promise which is going to be resolved once promise returned by func resolves

• func - function which is going to be limited

• thisArg - this object or null for calling the function

• arg1, arg2, ... - variable arguments list for func

  var promise = throttle.fapply(func, thisArg, args)

• promise - an Q promise which is going to be resolved once promise returned by func resolves

• func - function which is going to be limited

• thisArg - this object or null for calling the function

• args - arguments array for calling the function

  var promise = throttle.throttlize(funcs, thisArg)

Wraps array (or map) of functions with limits defined by throttle variable.

• promise - an Q promise which is going to be resolved once promise returned by func resolves

• funcs - array or map of functions which are going to be limited

• thisArg - this object or null for calling the function

Author

Karol Maciaszek [email protected]

License

(The MIT License)

Copyright (c) 2014 Karol Maciaszek [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.