spread-args

Makes functions that expect multiple arguments accept a single array instead.

Synopsis

spread-args is a JavaScript function for converting a function accepting multiple arguments into a function accepting a single array of arguments.

Why?

It's trivial to implement, but in order to keep code DRY (and avoid silly mistakes) it makes sense to define this function only once per project. This library is the logical consequence of that.

Install

npm install spread-args
git clone https://github.com/pluma/spread-args.git
cd spread-args
npm install
make
component install pluma/spread-args

Learn more about component.

bower install spread

Learn more about bower.

Download the latest minified CommonJS release and add it to your project.

Learn more about CommonJS modules.

Download the latest minified AMD release and add it to your project.

Learn more about AMD modules.

Download the latest minified standalone release and add it to your project.

<script src="/your/js/path/spread-args.globals.min.js"></script>

This makes the spread-args function available in the global namespace.

Basic usage example

var spread = require('spread-args');
 
var str = 'foo bar qux baz';
[
    [/o+/g, 'u'],
    [/a/g, 'o']
].forEach(spread(function(resubstitute) {
    str = str.replace(re, substitute);
}));
console.log(str); // "fu bor qux boz" 

API

Wraps the given function in a function that accepts an array as first argument and invokes the wrapped function with the array's contents as arguments.

If the returned function is invoked as a method, the this reference will be used to invoke the function.

If the returned function is passed additional arguments, they will be passed on as usual.

Example:

var spread = require('spread-args');
 
function join(abc) {
    return [a, b].join(|| '');
}
 
var join2 = spread(join);
 
join2(['foo', 'bar']); // 'foobar' 
join2(['foo', 'bar', '-']); // 'foo-bar' 
join2(['foo', 'bar'], '-'); // 'foo-bar' 

Wraps the given function in a function that accepts any number of arguments and invokes the wrapped function with an array containing the arguments.

If the returned function is invoked as a method, the this reference will be used to invoke the function.

Example:

var unspread = require('spread-args').unspread;
 
function join(arr) {
    return arr.join('-');
}
 
var join2 = unspread(join);
 
join2('foo', 'bar'); // 'foo-bar' 

Unlicense

This is free and unencumbered public domain software. For more information, see http://unlicense.org/ or the accompanying UNLICENSE file.