mirror of
https://github.com/nodejs/node.git
synced 2026-11-09 15:11:11 -05:00
Rebecca Turner
468ab4519e
PR-URL: https://github.com/nodejs/node/pull/20190 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
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.