Skip to content
Partial application for functions taking a single argument object
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
.gitignore
.npmrc
.travis.yml
README.md
examples.md
index.html
index.js
package.json

README.md

obind

Partial application for functions taking a single argument object.

NPM

Build status dependencies devdependencies semantic-release manpm

Install and use under Node: npm install obind --save

Use: obind(fn, partialOptions), returns new function.

Example

var obind = require('obind');
function foo(options) { ... }
var withBar = obind(foo, { bar: 'bar' });
withBar({ baz: 'baz' });
/*
equivalent to
foo({
    bar: 'bar',
    baz: 'baz'
})
*/

Information

It is like Function.prototype.bind but for function that expect single options object. Note, obind only does partial application, not context binding.

See Partial application for options object blog post.

For more examples, see this page.

In the browser include the script and then use window.obind function.

Additional arguments after the first object will be passed unchanged

function foo(options, a, b) { ... }
var bound = obind(foo, someOptions)
bound(moreOptions, a, b)
// same as
foo(moreOptions + someOptions, a, b)

Parameter destructuring

If you like ES6 parameter destructuring (and you should), then obind helps you partially apply it.

function mul({a, b}) { 
  console.log(a, b); 
  return a * b 
}
const double = obind(mul, {a: 2})
console.log(double({b: 3}))
// 2, 3
// 6

Read related blog post.

Small print

Author: Gleb Bahmutov © 2015

License: MIT - do anything with the code, but don't blame me if it does not work.

Spread the word: tweet, star on github, etc.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2015 Gleb Bahmutov

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.

You can’t perform that action at this time.