[Pkg-javascript-commits] [node-async] 30/480: added apply function

[Jonas Smedegaard]

This is an automated email from the git hooks/post-receive script.

js pushed a commit to branch master
in repository node-async.

commit 4d09ada9addaa056503968e89578edeaf3cd2851
Author: Caolan McMahon <caolan at caolanmcmahon.com>
Date:   Tue Jul 6 13:17:57 2010 +0100

    added apply function
---
 README.md          | 49 +++++++++++++++++++++++++++++++++++++++++++++++--
 lib/async.js       |  7 +++++++
 package.json       |  2 +-
 test/test-async.js | 13 +++++++++++++
 4 files changed, 68 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 1697917..80356c5 100644
--- a/README.md
+++ b/README.md
@@ -18,8 +18,9 @@ __This is not an attempt to replace the standard callback mechanism in
 node.__ In fact, it is designed to work as seamlessly as possible with the
 existing node modules, and any other module which follows those conventions.
 If you're interested in other ways to manage async code, then you may like
-to take a look at the new implementation of the old node Promise objects or
-alternative modules like node-continuables.
+to take a look at the new implementation of the old node Promise objects
+([node-promise](http://github.com/kriszyp/node-promise)) or alternative
+modules like [node-continuables](http://github.com/bentomas/node-continuables).
 
 __This module is also available as an npm package:__
 
@@ -61,6 +62,8 @@ __This module is also available as an npm package:__
   requirements.
 * __iterator__ - Creates an iterator function which calls the next function in
   the array, returning a continuation to call the next one after that.
+* __apply__ - Creates a continuation with some arguments already applied, a
+  useful shorthand when combined with other flow control functions.
 
 
 ## Collections
@@ -528,3 +531,45 @@ __Example__
     'three'
 
 
+### apply(function, arguments..)
+
+Creates a continuation function with some arguments already applied, a useful
+shorthand when combined with other flow control functions. Any arguments
+passed to the returned function are added to the arguments originally passed
+to apply.
+
+__Arguments__
+
+* function - The function you want to eventually apply all arguments to.
+* arguments... - Any number of arguments to automatically apply when the
+  continuation is called.
+
+__Example__
+
+    // using apply
+
+    async.parallel([
+        async.apply(fs.writeFile, 'testfile1', 'test1'),
+        async.apply(fs.writeFile, 'testfile2', 'test2'),
+    ]);
+
+
+    // the same process without using apply
+
+    async.parallel([
+        function(callback){
+            fs.writeFile('testfile1', 'test1', callback);
+        },
+        function(callback){
+            fs.writeFile('testfile2', 'test2', callback);
+        },
+    ]);
+
+It's possible to pass any number of additional arguments when calling the
+continuation:
+
+    node> var fn = async.apply(sys.puts, 'one');
+    node> fn('two', 'three');
+    one
+    two
+    three
diff --git a/lib/async.js b/lib/async.js
index cccf665..3a797e3 100644
--- a/lib/async.js
+++ b/lib/async.js
@@ -299,3 +299,10 @@ exports.iterator = function(tasks){
     };
     return makeCallback(0);
 };
+
+exports.apply = function(fn){
+    var args = Array.prototype.slice.call(arguments, 1);
+    return function(){
+        fn.apply(null, args.concat(Array.prototype.slice.call(arguments)));
+    };
+}
diff --git a/package.json b/package.json
index 59e3e7d..4b93a60 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,7 @@
 , "description": "Higher-order functions and common patterns for asynchronous code"
 , "main": "./index"
 , "author": "Caolan McMahon"
-, "version": "0.1.0"
+, "version": "0.1.1"
 , "repository" :
   { "type" : "git"
   , "url" : "http://github.com/caolan/async.git"
diff --git a/test/test-async.js b/test/test-async.js
index dde5773..0f81fc0 100644
--- a/test/test-async.js
+++ b/test/test-async.js
@@ -734,3 +734,16 @@ exports['sortBy'] = function(test){
         test.done();
     });
 };
+
+exports['apply'] = function(test){
+    test.expect(5);
+    var fn = function(){
+        test.same(Array.prototype.slice.call(arguments), [1,2,3,4])
+    };
+    async.apply(fn, 1, 2, 3, 4)();
+    async.apply(fn, 1, 2, 3)(4);
+    async.apply(fn, 1, 2)(3, 4);
+    async.apply(fn, 1)(2, 3, 4);
+    async.apply(fn)(1, 2, 3, 4);
+    test.done();
+};

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-async.git