defaults

Easily handle defaults for your options

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
defaults
7303.0.06 months ago11 years agoMinified + gzip package size for defaults in KB

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 options object
  • Supports deep merging of objects
  • Provides protection against prototype pollution attacks