https://github.com/marmelab/configurable.js
A small JS snippet to make a function configurable through its closure
https://github.com/marmelab/configurable.js
Last synced: about 2 months ago
JSON representation
A small JS snippet to make a function configurable through its closure
- Host: GitHub
- URL: https://github.com/marmelab/configurable.js
- Owner: marmelab
- License: mit
- Created: 2015-01-27T12:53:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-01-09T07:09:57.000Z (over 6 years ago)
- Last Synced: 2024-04-13T02:08:36.394Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 7
- Watchers: 14
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Configurable
============
Make a function configurable
Configurable functions modify their configuration.
The configuration is available from the function context `this`
```js
function bar() {
console.log('foo value is', this.config.foo);
}
bar.bind({ config: { foo: 1 } })(); // 'foo value is 1'
config.foo = 3;
bar.bind({ config: { foo: 3 } })(); // 'foo value is 3'
```
The configurable behavior modifies the function object, adding one
method for each item in the configuration.
The added methods use the same name as the configuration items. The
added methods are both setters and getters, which means that they return
the config value when called without argument, and they modify the
config value when called with an argument.
Additionally each config change create a new configured function.
This way it is easy to have several copy of the same function with different configuration.
```js
bar1 = configurable(bar, { foo: 1 });
// Now bar has a foo() method
bar1.foo(); // 1
bar1(); // 'foo value is 1'
var bar2 = bar1.foo(2)
bar2(); // 'foo value is 2'
bar2.foo(); // 2
// but bar1 stay the same
bar1.foo(); // 1
bar1(); // 'foo value is 1'
```
You can also configure a literal of function, this allow for several function to share the same config.
```js
var foo = {
logBar: function bar() {
console.log('bar value is', this.config.bar);
}
logRab: function barLength() {
console.log('reversed bar value is', this.config.bar.split('').reverse().join(''));
}
}
var foo1 = configurable(foo, { bar: 'hello' });
foo1.logBar(); // bar value is hello
foo1.logRab(); // reversed bar value is olleh
var foo2 = foo1.foo()
foo2.logBar(); // 'bar value is bye'
foo2.logRab(); // 'reversed bar value is yeb'
```