defaults
Advanced tools
Package description
The `defaults` npm package is primarily used for merging a set of default properties with user-provided options. It is particularly useful in situations where you want to ensure that an object contains a certain set of properties with default values, even if some of those properties are not provided by the user. This can be very handy in configuration objects for libraries, APIs, or any other modular pieces of code that require a predictable structure of input options.
Merging default options with user options
This feature allows the merging of a user-provided options object with a default options object. If the user provides a value for a given property, that value is used; otherwise, the default value is applied. This is particularly useful for configuring applications or modules where certain parameters are optional but should have a defined default behavior.
{"const defaults = require('defaults');\nconst userOptions = { color: 'blue' };\nconst defaultOptions = { color: 'red', size: 'large' };\nconst options = defaults(userOptions, defaultOptions);\nconsole.log(options); // Output: { color: 'blue', size: 'large' }"}Lodash's `merge` function offers deep merging capabilities, which can be more comprehensive than the shallow merge provided by `defaults`. It allows for the merging of nested properties, which is useful when dealing with complex object structures. However, for simple use cases, `defaults` might be more straightforward and lightweight.
Similar to `lodash.merge`, `deep-extend` provides deep merging functionality. It is designed to recursively merge properties of objects, making it suitable for complex configurations. Compared to `defaults`, `deep-extend` offers a more robust solution for nested properties but might be overkill for simple scenarios.
Readme
A simple one level options merge utility
npm install defaults
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
});
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.
FAQs
Easily handle defaults for your options
The npm package defaults receives a total of 12,588,136 weekly downloads. As such, defaults popularity was classified as popular.
We found that defaults demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.