node/deps/npm/node_modules/defaults
Myles Borins 2e54524955
deps: update npm to 7.0.0-rc.3
PR-URL: https://github.com/nodejs/node/pull/35474
Reviewed-By: Ruy Adorno <ruyadorno@github.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2020-10-07 09:59:49 -04:00
..
.npmignore deps: upgrade npm to 6.1.0 2018-05-24 23:24:45 -07:00
index.js deps: upgrade npm to 6.1.0 2018-05-24 23:24:45 -07:00
LICENSE deps: upgrade npm to 6.1.0 2018-05-24 23:24:45 -07:00
package.json deps: update npm to 7.0.0-rc.3 2020-10-07 09:59:49 -04:00
README.md deps: upgrade npm to 6.1.0 2018-05-24 23:24:45 -07:00
test.js deps: upgrade npm to 6.13.1 2019-11-20 19:16:47 -05:00

defaults

A simple one level options merge utility

install

npm install defaults

use


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