union-value

What is union-value?

The union-value npm package is used to add unique values to an array located at a specific property path within an object. It ensures that the values are not duplicated within the array.

What are union-value's main functionalities?

Add unique values to an array at a specific property path

This feature allows you to add a unique value to an array located at a specific property path within an object. In this example, the value 4 is added to the array at the path 'a.b.c'.

const union = require('union-value');
let obj = { a: { b: { c: [1, 2, 3] } } };
union(obj, 'a.b.c', 4);
console.log(obj); // { a: { b: { c: [1, 2, 3, 4] } } }

Add multiple unique values to an array at a specific property path

This feature allows you to add multiple unique values to an array located at a specific property path within an object. In this example, the values 4, 5, and 6 are added to the array at the path 'a.b.c'.

const union = require('union-value');
let obj = { a: { b: { c: [1, 2, 3] } } };
union(obj, 'a.b.c', [4, 5, 6]);
console.log(obj); // { a: { b: { c: [1, 2, 3, 4, 5, 6] } } }

Other packages similar to union-value

set-value

The set-value package allows you to set a value at a specific property path within an object. Unlike union-value, it does not ensure uniqueness of values in arrays but is more general-purpose for setting any value at a given path.

get-value

The get-value package is used to get the value at a specific property path within an object. It complements set-value but does not provide functionality for adding unique values to arrays like union-value.

has-value

The has-value package checks if a value exists at a specific property path within an object. It is useful for validation but does not modify the object like union-value.

unset-value

The unset-value package allows you to remove a value at a specific property path within an object. It is useful for cleanup operations but does not add values like union-value.

README

union-value

Set an array of unique values as a property of an object, using dot notation.

Install

Install with npm

$ npm i union-value --save

Usage

var union = require('union-value');

var obj = {};

union(obj, 'a.b.c', ['one', 'two']);
union(obj, 'a.b.c', ['three']);

console.log(obj);
//=> {a: {b: {c: [ 'one', 'two', 'three' ] }}}

Related projects

• get-value: Use property paths ( a.b.c) to get a nested value from an object.
• has-value: Returns true if a value exists, false if empty. Works with deeply nested values using… more
• set-value: Create nested values and any intermediaries using dot notation ('a.b.c') paths.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb-cli on July 04, 2015.