rename to directly

README.md

@@ -1,21 +1,24 @@
-# promise-throttle
+# directly
 
 ## Like Promise.all, only less so
 
-This module could more descriptively be named Promise.allButNotAllAtOnce. It takes an array of functions which return a promise and returns a promise which resolves once all the promises resolved by the promises have resolved, or otherwise rejects. The difference is that a maximum of `n` promises are created at any one time. This is useful for rate-limiting asynchronous calls which return promises (e.g. `fetch`, `mongoose`...);
+This module could more descriptively be named Promise.allButNotAllAtOnce. It takes an array of functions, each of which return a promise, and returns a promise which resolves once all those promises have resolved, or otherwise rejects... very similar to `Promise.all`. The difference is that a maximum of `n` promises are created at any one time. This is useful for rate-limiting asynchronous calls (e.g. `fetch`, `mongoose`...);
+
+## About the name
+In Devon people will often promise to do things 'directly', meaning they'll do it when they're good and ready
 
 ## Usage
 
 ```
-var PromiseThrottle = require('promise-throttle`);
+var Directly = require('directly`);
 var urls = []; // a big array of urls
 var fetchers = urls.map(function (url) {
     return function () {
         return fetch(url);
     }
 });
 
-var throttledRequests = new PromiseThrottle(10, fetchers)
+var throttledRequests = new Directly(10, fetchers)
 
 throttledRequests
     .run()
@@ -25,13 +28,14 @@ throttledRequests
 
 ```
 
-Can also be called as a function (which implicitly calls the `.run()` method internally)
+Can also be called as a function (which calls the `.run()` method internally)
+
 ```
-var promiseThrottle = require('promise-throttle');
-promiseThrottle(10, fetchers)
+var directly = require('directly');
+directly(10, fetchers)
     .then(function (results) {
         // handle exactly as if it was a Promise.all()
     });
 ```
 
-*Based on an idea originally developed [at FT](https://github.com/Financial-Times/next-user-preferences-api-v2/blob/master/lib/promise-throttle.js)*
+*Based on an idea originally developed [at FT](https://github.com/Financial-Times/next-user-preferences-api-v2/blob/master/lib/directly.js)*

bower.json

@@ -1,8 +1,8 @@
 {
-  "name": "promise-throttle",
-  "main": "promise-throttle.js",
+  "name": "directly",
+  "main": "directly.js",
   "version": "0.0.0",
-  "homepage": "https://github.com/wheresrhys/promise-throttle",
+  "homepage": "https://github.com/wheresrhys/directly",
   "authors": [
     "Rhys Evans <wheresrhys@gmail.com>"
   ],

promise-throttle.js → directly.js

@@ -2,18 +2,18 @@
 
 require('es6-promise').polyfill();
 
-var PromiseThrottle = function (throttleLimit, funcs) {
-	if (!(this instanceof PromiseThrottle)) {
-		return new PromiseThrottle(throttleLimit, funcs).run();
+var Directly = function (concurrence, funcs) {
+	if (!(this instanceof Directly)) {
+		return new Directly(concurrence, funcs).run();
 	}
 	this.results = [];
-	this.throttleLimit = throttleLimit;
+	this.concurrence = concurrence;
 	this.funcs = funcs;
 	this.counter = 0;
 };
 
-PromiseThrottle.prototype.run = function () {
-	if (this.funcs.length <= this.throttleLimit) {
+Directly.prototype.run = function () {
+	if (this.funcs.length <= this.concurrence) {
 		return Promise.all(this.funcs.map(function (func) {
 			return func();
 		}));
@@ -24,7 +24,7 @@ PromiseThrottle.prototype.run = function () {
 		this.reject = reject;
 	}.bind(this));
 
-	var i = this.throttleLimit;
+	var i = this.concurrence;
 
 	while (i--) {
 		this.executeOne();
@@ -34,7 +34,7 @@ PromiseThrottle.prototype.run = function () {
 	return this.promise;
 };
 
-PromiseThrottle.prototype.executeOne = function () {
+Directly.prototype.executeOne = function () {
 	var promise = this.funcs.shift()();
 
 	this.results.push(promise);
@@ -46,7 +46,7 @@ PromiseThrottle.prototype.executeOne = function () {
 	this.competitors.push(promise);
 };
 
-PromiseThrottle.prototype.startRace = function () {
+Directly.prototype.startRace = function () {
 	Promise.race(this.competitors)
 		.then(function (index) {
 			if (!this.funcs.length) {
@@ -67,4 +67,4 @@ PromiseThrottle.prototype.startRace = function () {
 };
 
 
-module.exports = PromiseThrottle;
+module.exports = Directly;

package.json

@@ -1,14 +1,14 @@
 {
-  "name": "promise-throttle",
-  "version": "1.0.0",
+  "name": "directly",
+  "version": "1.0.1",
   "description": "Like Promise.all, only less so",
-  "main": "promise-throttle.js",
+  "main": "directly.js",
   "scripts": {
     "test": "mocha"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/wheresrhys/promise-throttle.git"
+    "url": "https://github.com/wheresrhys/directly.git"
   },
   "keywords": [
     "promise",
@@ -20,9 +20,9 @@
   "author": "Rhys Evans",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/wheresrhys/promise-throttle/issues"
+    "url": "https://github.com/wheresrhys/directly/issues"
   },
-  "homepage": "https://github.com/wheresrhys/promise-throttle",
+  "homepage": "https://github.com/wheresrhys/directly",
   "devDependencies": {
     "chai": "^3.2.0",
     "mocha": "^2.2.5"

test/promise-throttle.test.js → test/directly.test.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var expect = require('chai').expect;
-var PromiseThrottle = require('../promise-throttle');
+var Directly = require('../directly');
 
 var setupPromises = function (n) {
 
@@ -49,7 +49,7 @@ describe('concordance with Promise.all', function () {
 		it('should resolve if they all resolve', function (done) {
 			var promises = setupPromises(2);
 
-			new PromiseThrottle(3, promises.functions).run()
+			new Directly(3, promises.functions).run()
 				.then(function (res) {
 					expect(res).to.eql([0, 1]);
 					done();
@@ -64,7 +64,7 @@ describe('concordance with Promise.all', function () {
 		it('should reject if any of them reject', function (done) {
 			var promises = setupPromises(2);
 
-			new PromiseThrottle(3, promises.functions).run()
+			new Directly(3, promises.functions).run()
 				.catch(function (res) {
 					expect(res).to.equal('err1');
 					done();
@@ -79,7 +79,7 @@ describe('concordance with Promise.all', function () {
 		it('should resolve if they all resolve', function (done) {
 			var promises = setupPromises(3);
 
-			new PromiseThrottle(3, promises.functions).run()
+			new Directly(3, promises.functions).run()
 				.then(function (res) {
 					expect(res).to.eql([0, 1, 2]);
 					done();
@@ -94,7 +94,7 @@ describe('concordance with Promise.all', function () {
 		it('should reject if any of them reject', function (done) {
 			var promises = setupPromises(3);
 
-			new PromiseThrottle(3, promises.functions).run()
+			new Directly(3, promises.functions).run()
 				.catch(function (res) {
 					expect(res).to.equal('err1');
 					done();
@@ -108,7 +108,7 @@ describe('concordance with Promise.all', function () {
 		it('should resolve if they all resolve', function (done) {
 			var promises = setupPromises(4);
 
-			new PromiseThrottle(3, promises.functions).run()
+			new Directly(3, promises.functions).run()
 				.then(function (res) {
 					expect(res).to.eql([0, 1, 2, 3]);
 					done();
@@ -123,7 +123,7 @@ describe('concordance with Promise.all', function () {
 		it('should reject if any of them reject', function (done) {
 			var promises = setupPromises(4);
 
-			new PromiseThrottle(3, promises.functions).run()
+			new Directly(3, promises.functions).run()
 				.catch(function (res) {
 					expect(res).to.equal('err1');
 					done();
@@ -135,7 +135,7 @@ describe('concordance with Promise.all', function () {
 		it('should preserve promise order in the results', function () {
 			var promises = setupPromises(4);
 
-			new PromiseThrottle(3, promises.functions).run()
+			new Directly(3, promises.functions).run()
 				.then(function (res) {
 					expect(res).to.eql([1,2,3,4]);
 					done();
@@ -158,7 +158,7 @@ describe('throttling', function () {
 			spyVal = true;
 		});
 
-		new PromiseThrottle(3, promises.functions).run()
+		new Directly(3, promises.functions).run()
 
 		expect(spyVal).to.be.false;
 	});
@@ -179,7 +179,7 @@ describe('throttling', function () {
 			return func4();
 		}
 
-		new PromiseThrottle(3, promises.functions).run()
+		new Directly(3, promises.functions).run()
 
 		expect(spyVals).to.eql([]);
 
@@ -208,7 +208,7 @@ describe('functional calling', function () {
 	it('should be callable as a function', function (done) {
 		var promises = setupPromises(3);
 
-		PromiseThrottle(3, promises.functions)
+		Directly(3, promises.functions)
 			.then(function (res) {
 				expect(res).to.eql([0, 1, 2]);
 				done();