Security News
How Threat Actors are Abusing GitHub’s File Upload Feature to Host Malware
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
By Sarah Gooding - Apr 23, 2024
defaults
Advanced tools
- Version published
- Weekly downloads
- 20M
- increased by2.34%
- Maintainers
- 1
- Install size
- 5.52 kB
- Created
- Weekly downloads
Package description
What is defaults?
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.
What are defaults's main functionalities?
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' }"}Other packages similar to defaults
lodash.merge
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.
deep-extend
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
defaults
Easily handle defaults for your options
Install
npm install defaults
Usage
import defaults from 'defaults';
const calculate = options => {
options = defaults(options, {
timeout: {
before: 100,
after: 100
}
});
console.log(options);
//=> {timeout: {before: 200, after: 100}}
// …
}
// …
calculate({timeout: {before: 200}});
API
defaults(options, defaultOptions?)
Deeply merges the given options with the specified defaults and returns a new object.
The given parameters are deep-cloned and never mutated.
options
Type: object
The user-provided options.
If the value is not a plain object, a new plain object will be used instead.
defaultOptions
Type: object | undefined
The default options to use when a value is not provided in the options object.
FAQ
Why use this over object-spread?
- Does not overwrite options if they are not defined in the
optionsobject - Supports deep merging of objects
- Provides protection against prototype pollution attacks
FAQs
Easily handle defaults for your options
The npm package defaults receives a total of 16,473,608 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.
Last updated on 18 Oct 2023
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.
Related posts
Security News
The Dark Side of Open Source
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.
By Sarah Gooding - Apr 19, 2024
Research
Security News
npm Package for ReExt React Components Library Exfiltrates Git Credentials
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
By Sarah Gooding, Socket Research Team - Apr 18, 2024