Files
add-and-commit/node_modules/defaults/README.md
Federico Grandi f118062594 Update with working working version (#12)
* Fix workflow

* Trigger

* [auto] Update compiled version

* [auto] Commit modules

* Push Windows changes

* Fix

* [auto] Update compiled version

* Try removing cwd

* [auto] Update compiled version

* Try with path module

* [auto] Update compiled version

* Fix path

* [auto] Update compiled version

* Use raw path

* [auto] Update compiled version

* Other path

* [auto] Update compiled version

* Avoid @action/exec

* [auto] Update compiled version

* test

* [auto] Update compiled version

* test

* [auto] Update compiled version

* test

* [auto] Update compiled version

* test

* [auto] Update compiled version

* Try with shelljs

* [auto] Update compiled version

* Fix my stupidity

* Copy scripts to local dir

* [auto] Update compiled version

* Still use path

* [auto] Update compiled version

* Delete entrypoint.sh

* [auto] Update compiled version

* Make file executable

* [auto] Update compiled version

* Try using bash

* [auto] Update compiled version
2019-12-14 21:47:13 +01:00

44 lines
827 B
Markdown

# defaults
A simple one level options merge utility
## install
`npm install defaults`
## use
```javascript
var defaults = require('defaults');
var handle = function(options, fn) {
options = defaults(options, {
timeout: 100
});
setTimeout(function() {
fn(options);
}, options.timeout);
}
handle({ timeout: 1000 }, function() {
// we're here 1000 ms later
});
handle({ timeout: 10000 }, function() {
// we're here 10s later
});
```
## summary
this module exports a function that takes 2 arguments: `options` and `defaults`. When called, it overrides all of `undefined` properties in `options` with the clones of properties defined in `defaults`
Sidecases: if called with a falsy `options` value, options will be initialized to a new object before being merged onto.
## license
[MIT](LICENSE)