Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fwilkerson/clean-set
A deep assignment alternative to the object spread operator and Object.assign
https://github.com/fwilkerson/clean-set
Last synced: 23 days ago
JSON representation
A deep assignment alternative to the object spread operator and Object.assign
- Host: GitHub
- URL: https://github.com/fwilkerson/clean-set
- Owner: fwilkerson
- License: mit
- Created: 2018-06-06T05:03:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:33:52.000Z (almost 2 years ago)
- Last Synced: 2024-04-27T17:32:46.521Z (8 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/clean-set
- Size: 881 KB
- Stars: 177
- Watchers: 2
- Forks: 8
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-javascript - clean-set
- awesome-javascript - clean-set
README
# clean-set
[](https://github.com/prettier/prettier)
[](https://travis-ci.org/fwilkerson/clean-set)
[](https://codecov.io/gh/fwilkerson/clean-set)
> Quickly update a value in a deeply nested object and clone each node touched for simple change tracking `===`.
Check out [dset](https://github.com/lukeed/dset) if you just want to do an in place mutation on a deeply nested value.
## Install
> npm i clean-set
Includes builds for commonjs, umd, and esm and is less than ~~200b~~ 182b gzip (thanks to [@lukeed](https://github.com/lukeed))
## Usage
```javascript
let current = {
a: { b: [], c: true },
d: [],
e: {
f: { g: 'hello' },
h: { i: 0 },
},
};
let next = cleanSet(current, 'e.h.i', 1);
/**
* Alternatively you can provide a function for the final parameter to
* receive the current value of that node.
*
* let next = cleanSet(current, 'e.h.i', i => i + 1);
*/
// The value is assigned
console.log(next.e.h.i !== current.e.h.i); // true
// Each parent node touched is a new reference
console.log(next.e.h !== current.e.h); // true
console.log(next.e !== current.e); // true
console.log(next !== current); // true
// Untouched references remain the same
console.log(next.e.f === current.e.f); // true
console.log(next.a === current.a); // true
console.log(next.a.b === current.a.b); // true
console.log(next.d === current.d); // true
```
Here's what an object spread equivalent would look like.
```javascript
let next = {
...current,
e: {
...current.e,
h: { ...current.e.h, i: 1 },
},
};
```
## Benchmarks
Check out the [es bench link](https://esbench.com/bench/5b16f1cbf2949800a0f61cf2) to run the benchmarks yourself.
> Note: YMMV canary and firefox dev have some impressive improvements for object assign and object spread respectively.
Chrome 67
