merge-all-objects
v1.0.4
Published
🚀 merge-all-objects is a function that allows you to merge thousands of objects with recursion, and with exclusions as well
Downloads
13
Readme
Merge all objects
merge-all-objects
is a function that allows you to merge thousands of objects with recursion, and with exclusions as well
Installation
# For npm
npm install --save merge-all-objects
# For yarn
yarn add merge-all-objects
Usage
import { Merge } from 'merge-all-objects';
// First object
const obj1 = {
app: {
name: 'Application',
},
circle: {
one: {},
},
'@remove/bucle': {
one: { one: 'First' },
},
'@exclude/bucle': {
one: { one: 'First' },
},
};
// Second object
const obj2 = {
app: {
port: 8080,
},
circle: {
two: {},
},
'@remove/bucle': {
two: { two: 'Second' },
},
'@exclude/bucle': {
two: { two: 'Second' },
},
};
const data = Merge(obj1, obj2); // accept unlimited items!
{
"app": {
"name": "Application",
"port": 8080,
"circle": {
"one": {},
"two": {}
},
"@delete/bucle": {
"one": { "one": "First" },
"two": { "two": "First" }
},
"@exclude/bucle": {
"one": { "one": "Second" },
"two": { "two": "Second" }
}
}
}
🎁 Options
the options will always be added at the end of the one between the parameters
Merge(
obj1,
obj2,
obj3,
obj4,
obj5,
/* always in the end the options */ {
removedKeys: [],
removedValues: [],
excludedKeys: [],
excludedValues: [],
},
);
Removed (keys, values)
The option to delete objects by their keys or values is also available, as follows
Merge(obj1, obj2, {
// Delete by key
removedKeys: ['@circle', /^\@delete/],
// Delete by values
removedValues: [/^Second/, 8080],
});
{
"app": {
"name": "Application",
"circle": {
"one": {},
"two": {}
},
"@exclude/bucle": {
"one": {},
"two": {}
}
}
}
Excluded (keys, values)
- The
merge-all-objects
allows to exclude some object keys for recursion ! - You will be assigned the last value found that matches your key !
// To add the keys to be excluded always add them at the end in the
Merge(obj1, obj2, {
// Exclude for keys
excludedKeys: ['circle', /^\@exclude/],
});
{
"app": {
"name": "Application",
"port": 8080,
"circle": {
"two": {}
},
"@delete/bucle": {
"one": { "one": "First" },
"two": { "two": "First" }
},
"@exclude/bucle": {
"two": { "two": "Second" }
}
}
}
⭐ Support for
merge-all-objects
is an open source project licensed by MIT. You can grow thanks to the sponsors and the support of the amazing sponsors. If you want to join them, contact me here.
🎩 Stay in touch
- Github @yonicalsin
- Twitter @yonicalsin
- Instagram @yoni_calsin
- Medium @yonicalsin
Contributors
Thanks to the wonderful people who collaborate with me !
📜 License
merge-all-objects
under License MIT.