defaults

Easily handle defaults for your options

Install

1npm install defaults

Usage

1import defaults from 'defaults';
2
3const calculate = options => {
4	options = defaults(options, {
5		timeout: {
6			before: 100,
7			after: 100
8		}
9	});
10
11	console.log(options);
12	//=> {timeout: {before: 200, after: 100}}
13
14	// …
15}
16
17// …
18
19calculate({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 options object
• Supports deep merging of objects
• Provides protection against prototype pollution attacks