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 the property of an object. Supports setting deeply nested properties using using object-paths/dot notation.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save union-value

Usage

const union = require('union-value');
const obj = {};

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

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

About

Contributing

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

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• assign-value: Assign a value or extend a deeply nested property of an object using object path… more | homepage
• get-value: Use property paths like 'a.b.c' to get a nested value from an object. Even works… more | homepage
• has-value: Returns true if a value exists, false if empty. Works with deeply nested values using… more | homepage
• set-value: Create nested values and any intermediaries using dot notation ('a.b.c') paths. | homepage
• unset-value: Delete nested properties from an object using dot notation. | homepage

Contributors

Commits	Contributor
23	jonschlinkert
1	wtgtybhertgeghgtwtg

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2019, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.8.0, on June 20, 2019.