Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juanluispaz/clone-deep-circular-references
Shallow and recursively (deep) clone JavaScript objects that handles circular references
https://github.com/juanluispaz/clone-deep-circular-references
Last synced: 8 days ago
JSON representation
Shallow and recursively (deep) clone JavaScript objects that handles circular references
- Host: GitHub
- URL: https://github.com/juanluispaz/clone-deep-circular-references
- Owner: juanluispaz
- License: mit
- Created: 2019-08-05T16:33:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-23T13:19:39.000Z (about 4 years ago)
- Last Synced: 2024-10-31T07:04:27.008Z (15 days ago)
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# clone-deep-circular-references
[](http://npm.im/clone-deep-circular-references)
[](https://travis-ci.org/juanluispaz/clone-deep-circular-references)
[](https://coveralls.io/github/juanluispaz/clone-deep-circular-references?branch=master)
[](https://bundlephobia.com/result?p=clone-deep-circular-references)
[](https://bundlephobia.com/result?p=clone-deep-circular-references)
Shallow object colone and recursively (deep) clone JavaScript objects that handles circular references.
This is a reimplementation of the package [clone-deep](https://www.npmjs.com/package/clone-deep) to allow have circular references; as well, a reimplementation of [shallow-clone](https://www.npmjs.com/package/shallow-clone) to make it friendly with webpack.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save clone-deep-circular-references
```
## Basic usage
In this way you need to call the `cloneDeep` or the `cloneShallow` function passing as first argument the value to clone.
```js
import { cloneDeep, cloneShallow } from 'clone-deep-circular-references';
let obj = { a: 'b' };
let arr = [obj];
let deepCopy = cloneDeep(arr);
let shallowCopy = cloneShallow(arr);
obj.c = 'd';
shallowCopy.push('hello');
console.log(deepCopy);
//=> [{ a: 'b' }]
console.log(arr);
//=> [{ a: 'b', c: 'd' }]
console.log(shallowCopy);
//=> [{ a: 'b', c: 'd' }, 'hello']
```
## Cloning custom classes
By default, if a no plain object is found, no copy will be created; if you want to change it, you need to specify true as second argument. Note: in this way the class's constructor will not be called (a new object with the same prototype will be created), and then each property will be set.
```js
import { cloneDeep, cloneShallow } from 'clone-deep-circular-references';
class MyClass {
constructor(value) {
this.prop = value;
}
}
let obj = { a: new MyClass('b') };
let deepCopy = cloneDeep(arr);
console.log(obj === deepCopy);
//=> true
console.log(obj.a === deepCopy.a);
//=> true
deepCopy = cloneDeep(arr, true);
console.log(obj === deepCopy);
//=> false
console.log(obj.a === deepCopy.a);
//=> false
let shallowCopy = cloneShallow(arr);
console.log(obj === shallowCopy);
//=> true
console.log(obj.a === shallowCopy.a);
//=> true
shallowCopy = cloneShallow(arr, true);
console.log(obj === shallowCopy);
//=> false
console.log(obj.a === shallowCopy.a);
//=> true
```
## Controlling how custom classes are cloned
If you want to control how how no plain objects are copied you can specify a function as second argument that copy the value; this function receives as first argument the value to clone and as second argument the a Map with the object already cloned.
**Note**: if inside the `cloneDeep` function you want to call the `cloneDeep` function you need to pass a third argument the map with the object already cloned.
```js
import { cloneDeep, cloneShallow } from 'clone-deep-circular-references';
class MyClass {
constructor(value) {
this.prop = value;
}
}
let obj = { a: new MyClass('b') };
let deepCopy = cloneDeep(arr, function myCustomClone(value, instancesMap) {
if (value instanceof MyClass) {
return new MyClass(value.prop)
}
return cloneDeep(value, myCustomClone, instancesMap);
});
console.log(obj === deepCopy);
//=> false
console.log(obj.a === deepCopy.a);
//=> false
let shallowCopy = cloneShallow(arr, function myCustomClone(value) {
if (value instanceof MyClass) {
return new MyClass(value.prop)
}
return cloneShallow(value, myCustomClone);
});
console.log(obj === shallowCopy);
//=> false
console.log(obj.a === shallowCopy.a);
//=> true
```
## Handled types
The following types are handled recursively by the `cloneDeep` function:
* Plain objects
* No plain objects (see the previous documentation)
* Arrays
* Map
* Set
The other object types are copied using the `cloneShallow`function.
The following types are handled by the `cloneShallow` function:
* Plain objects
* No plain objects (see the previous documentation)
* Arrays
* Map
* Set
* Date
* RegExp
* Error
The following types are returned without create a copy:
* Symbol
* Promise
* WeakMap
* WeakSet
* Buffer (nodejs)
* ArrayBuffer
* Int8Array
* Uint8Array
* Uint8ClampedArray
* Int16Array
* Uint16Array
* Int32Array
* Uint32Array
* Float32Array
* Float64Array
* undefined
* null
* boolean
* string
* number
* function
* iterator
* any other special JavaScript object
## Related projects
You might also be interested in these projects:
* [clone-deep](https://www.npmjs.com/package/clone-deep): Recursively (deep) clone JavaScript native types, like Object, Array, RegExp, Date as well as primitives. | [homepage](https://github.com/jonschlinkert/clone-deep "Recursively (deep) clone JavaScript native types, like Object, Array, RegExp, Date as well as primitives.")
* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object "Returns true if an object was created by the `Object` constructor.")
* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of "Get the native type of a value.")
* [shallow-clone](https://www.npmjs.com/package/shallow-clone): Creates a shallow clone of any JavaScript value. | [homepage](https://github.com/jonschlinkert/shallow-clone "Creates a shallow clone of any JavaScript value.")
## License
MIT