simple-options v1.0.0

Simple Options

This component merges given options with default options. It raises an error if required options are missing.

Installation

Get it via npm:

npm install --save simple-options

Features

• deep merging of options with defaults.
• simple types are copied to the source; complex objects are merged.
• Merging of arrays.
  • If an item does not exist in the source array it is filled with the value from the defaults.
  • If the source array contains more elements than the defaults the additional valus are kept without any error.
  • The elements of an array are merged as well (recursivly).
• required options are specified by mention them in the defaults as undefined or null.

Restrictions

• no type checks on properties. No error is raised if the property type of source and defaults differs.

Examples

Define required options:

var options = require('../lib/simple-options');
var usedOptions = options({name: 'a'}, {name: undefined});

Result:

var usedOptions = {name: 'a'}

Raise error if required options are missing:

var options = require('../lib/simple-options');
var usedOptions = options({name: 'a'}, {name: undefined, index: undefined});

Merging arrays:

var options = require('../lib/simple-options');
var usedOptions = options({name: 'a', items: ['a', 'b']}, {name: undefined, items: ['x', 'y', 'z']});

Result:

var usedOptions = {name: 'a', items: ['a', 'b', 'z']}

var options = require('../lib/simple-options');
var usedOptions = options({name: 'a', items: ['a', 'b', 'c']}, {name: undefined, items: ['x', 'y']});

Result:

var usedOptions = {name: 'a', items: ['a', 'b', 'c']}

var options = require('../lib/simple-options');
var usedOptions = options([{item: {name: 'A'}}, {item: {name: 'B'}}], [{item: {name: 'C', number: 2}}, {item: {name: 'D', number: 2}}]);

Result:

var usedOptions = [{item: {name: 'A', number: 2}}, {item: {name: 'B', number: 2}}]

For more examples see tests.

License

MIT