# deep-copy-all
> deep copy JavaScript data of any type
Latest version **1.3.4** (published 2021-02-17) · MIT license · 0 weekly downloads
## Install
```sh
npm install deep-copy-all
pnpm add deep-copy-all
yarn add deep-copy-all
bun add deep-copy-all
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.3.4 |
| Published | 2021-02-17 |
| First published | 2020-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 99.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Terry Morse |
| Maintainers | terrymorse |
| Keywords | javascript, copy, clone, deep, deep copy |
## Links
- npm: https://www.npmjs.com/package/deep-copy-all
- Repository: https://github.com/terrymorse58/deep-copy-all
- Homepage: https://github.com/terrymorse58/deep-copy-all#readme
- Issues: https://github.com/terrymorse58/deep-copy-all/issues
- npm.io page: https://npm.io/package/deep-copy-all
## Recent versions
- 1.3.4 (latest) — 2021-02-17
- 1.3.3 — 2021-02-15
- 1.3.2 — 2021-01-12
- 1.3.1 — 2020-02-15
- 1.2.4 — 2020-02-14
- 1.2.3 — 2020-02-13
- 1.2.2 — 2020-02-10
- 1.2.1 — 2020-02-10
- 1.2.0 — 2020-02-07
- 1.1.9 — 2020-02-07
- 1.1.8 — 2020-02-06
- 1.1.6 — 2020-02-06
- 1.1.3 — 2020-02-06
- 1.1.2 — 2020-02-06
- 1.1.1 — 2020-02-05
- … 8 more at https://npm.io/package/deep-copy-all/versions
## README
# `deep-copy-all` #
A fast, compact, and robust method to deep copy all JavaScript data types
---
[](https://codebeat.co/projects/github-com-terrymorse58-deep-copy-all-master)
[](https://twitter.com/terrymorse)
**deep-copy-all** JavaScript object deep cloner is:
- fast – ranking highly on common benchmark speed tests
- compact – about 5k (minified)
- robust – correctly handling all
standard JavaScript data types, as well as custom types
## Install ##
```shell script
$ npm install deep-copy-all
```
## Usage ##
Node.js
````javascript
const deepCopy = require('deep-copy-all');
/* ... */
copy = deepCopy(source);
````
HTML file:
```html
```
---
## Comparison
The accuracy of **deep-copy-all** compares well against other deep copying
packages.
Legend: ☑️ - deep copy
🚧 - shallow copy
🗑️ - data loss
⚠️ - Error
data type | JSON.* | ce | d-c | dc | cl | f-c | deep-copy-all
----------------- | ------ | --- | --- | --- | --- | --- | -------------
Array | ☑️ | ☑️ |☑️|☑️|☑️|☑️|☑️
ArrayBuffer | 🗑️ | 🗑️ |🗑️|☑️|🗑️|☑️|☑️
BigInt | ⚠️ | ☑️ |☑️|☑️|☑️|☑️|☑️
BigInt64Array | ⚠️ | 🗑️ |🗑️|🚧|☑️|☑️|☑️
BigUint64Array | ⚠️ | 🗑️ |🗑️|🚧|☑️|☑️|☑️
Buffer | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Date | 🗑️ | ☑️ |☑️|☑️|☑️|☑️|☑️
Error | 🗑️ | 🗑️ |🗑️|🚧|☑️|🚧|☑️
Float32Array | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Float64Array | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Int8Array | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Int8Array | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Int32Array | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Map | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Object | ☑️ | ☑️ |☑️|☑️|☑️|☑️|☑️
RegExp | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Set | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Uint8Array | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Uint8ClampedArray | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Uint16Array | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
Uint32Array | 🗑️ | 🗑️ |🗑️|☑️|☑️|☑️|☑️
WeakMap | 🗑️ | 🗑️ |🗑️|🚧|⚠️|🚧|🚧
WeakSet | 🗑️ | 🗑️ |🗑️|🚧|⚠️|🚧|🚧
enumerable:false | 🗑️ | 🗑️ |🗑️|🗑️|🗑️|🗑️|☑️
custom Array | 🗑️ | 🗑️ |🗑️|🗑️|🗑️|☑️|☑️
custom Object | 🗑️ | 🗑️ |🗑️|🗑️|☑️|☑️|☑️
circular Object | ⚠️ | ☑️ |⚠️|☑️|☑️|🗑️|☑️
JSON.* - JSON.parse(JSON.stringify())
ce - [cloneextend](https://www.npmjs.com/package/cloneextend)
d-c - [deep-copy](https://www.npmjs.com/package/cloneextend)
dc - [deepcopy](https://www.npmjs.com/package/deepcopy)
cl - [clone](https://www.npmjs.com/package/clone)
f-c - [fast-copy](https://www.npmjs.com/package/fast-copy)
---
## `deepCopy()` ##
Perform deep copy of a JavaScript object or array.
#### Syntax ####
````
deepCopy(source [, options])
````
#### Parameters ####
`source`
The item to copy.
`options`
{Object} *[optional]* - Modifies copying behavior.
`options` properties:
`goDeep`
{Boolean} *[optional]* - Perform deep copy if *true* (default).
Set to **false** to perform shallow copy.
`includeNonEnumerable`
{Boolean} *[optional]* - Copies non-enumerable properties if *true*.
Skips non-enumerable properties if *false* (default).
`detectCircular`
{Boolean} *[optional]* - Detect circular references if **true** (default).
May be set to *false* if source has no circular references.
`maxDepth`
{number} *[optional]* - The maximum depth to copy, default is 20 levels.
#### Return value ####
The copied data.
---
## Performance ##
The following data types — passed directly to deepCopy or embedded within
another object — have been verified to be copied correctly:
- `Array`
- `ArrayBuffer`
- `Buffer` (node.js)
- `Date`
- `Error`
- `RegExp`
- `Int8Array`
- `Uint8Array`
- `Uint8ClampedArray`
- `Int16Array`
- `Uint16Array`
- `Int32Array`
- `Uint32Array`
- `Float32Array`
- `Float64Array`
- `BigInt64Array`
- `BigUint64Array`
- `Map`
- `Set`
- `Object`
- custom Array
- custom Object
Primtive data types are *not* deep copied. Instead, their
values are copied:
- `Number`
- `String`
- `Boolean`
- `undefined`
- `BigInt`
- `Symbol`
- `null`
The following object types are not deep copied, as no way has been found to copy
them. They are copied by reference only:
- `Function`
- `WeakMap`
- `WeakSet`
## Benchmark ##
In a standard
[benchmark test](https://github.com/ahmadnassri/benchmark-node-clone)
of 14 commonly used deep copy modules, **deep-copy-all**
was 4th fastest.
---
_Source: https://npm.io/package/deep-copy-all · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._