@stdlib/utils-copy

Copy or deep clone a value to an arbitrary depth.

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.1%) to scientific vocabulary

Keywords

array clone copy cp date deep deepclone deepcopy javascript node node-js nodejs object regexp shallow shallowcopy stdlib util utilities utils

Keywords from Contributors

iterator name tokenizer accumulator normal assert capitals abbreviate inherited reduced

Last synced: 6 months ago · JSON representation ·

Repository

Copy or deep clone a value to an arbitrary depth.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 1.49 MB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

array clone copy cp date deep deepclone deepcopy javascript node node-js nodejs object regexp shallow shallowcopy stdlib util utilities utils

Created over 4 years ago · Last pushed 8 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Copy

Copy or deep clone a value to an arbitrary depth.

## Installation ```bash npm install @stdlib/utils-copy ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var copy = require( '@stdlib/utils-copy' ); ``` #### copy( value\[, level] ) Copies or deep clones an input `value` to an arbitrary depth. The function accepts both `objects` and `primitives`. ```javascript // Primitives... var out = copy( 'beep' ); // returns 'beep' // Objects... var value = [ { 'a': 1, 'b': true, 'c': [ 1, 2, 3 ] } ]; out = copy( value ); // returns [ { 'a': 1, 'b': true, 'c': [ 1, 2, 3 ] } ] var bool = ( value[0].c === out[0].c ); // returns false // Error object... var err1 = new TypeError( 'beep' ); var err2 = copy( err1 ); // returns ``` The default behavior returns a **full** deep copy of any `object`. To limit the copy depth, set the `level` option. ```javascript var value = [ { 'a': 1, 'b': true, 'c': [ 1, 2, 3 ] } ]; // Trivial case => return the same reference var out = copy( value, 0 ); // returns [ { 'a': 1, 'b': true, 'c': [ 1, 2, 3 ] } ] var bool = ( value[0] === out[0] ); // returns true // Shallow copy: out = copy( value, 1 ); bool = ( value === out ); // returns false bool = ( value[0] === out[0] ); // returns true // Deep copy: out = copy( value, 2 ); bool = ( value[0] === out[0] ); // returns false bool = ( value[0].c === out[0].c ); // returns true ```

## Notes - List of **supported** values/types: - `undefined` - `null` - `boolean`/`Boolean` - `string`/`String` - `number`/`Number` - `function` - `Object` - `Date` - `RegExp` - `Set` - `Map` - [`Error`][mdn-error] - [`URIError`][mdn-uri-error] - [`ReferenceError`][mdn-reference-error] - [`SyntaxError`][mdn-syntax-error] - [`RangeError`][mdn-range-error] - [`EvalError`][mdn-eval-error] - [`TypeError`][mdn-type-error] - [`System Error`][node-system-error] (Node.js) - `Array` - `Int8Array` - `Uint8Array` - `Uint8ClampedArray` - `Init16Array` - `Uint16Array` - `Int32Array` - `Uint32Array` - `Float32Array` - `Float64Array` - `Buffer` ([Node.js][node-buffer]) - List of **unsupported** values/types: - `DOMElement`: to copy DOM elements, use `element.cloneNode()`. - `Symbol` - `WeakMap` - `WeakSet` - `Blob` - `File` - `FileList` - `ImageData` - `ImageBitmap` - `ArrayBuffer` - The implementation **can** handle circular references. - If a `Number`, `String`, or `Boolean` object is encountered, the value is cloned as a **primitive**. This behavior is intentional. The implementation is opinionated in wanting to **avoid** creating `numbers`, `strings`, and `booleans` via the `new` operator and a constructor. - For `objects`, the implementation **only** copies `enumerable` keys and their associated property descriptors. - The implementation **only** checks whether basic `Objects`, `Arrays`, and class instances are `extensible`, `sealed`, and/or `frozen`. - `functions` are **not** cloned; their reference is copied. - The implementation supports custom [`error`][mdn-error] types which are [`Error`][mdn-error] instances (e.g., ES2015 subclasses). - Support for copying class instances is inherently **fragile**. Any instances with privileged access to variables (e.g., within closures) cannot be cloned. This stated, basic copying of class instances is supported. Provided an environment which supports ES5, the implementation is greedy and performs a deep clone of any arbitrary class instance and its properties. The implementation assumes that the concept of `level` applies only to the class instance reference, but not to its internal state. ```javascript function Foo() { this._data = [ 1, 2, 3, 4 ]; this._name = 'bar'; return this; } var foo1 = new Foo(); var foo2 = copy( foo1 ); var bool = ( foo1._name === foo2._name ); // returns true bool = ( foo1._data === foo2._data ); // returns false bool = ( foo1._data[0] === foo2._data[0] ); // returns true ```

## Examples ```javascript var randu = require( '@stdlib/random-base-randu' ); var Int32Array = require( '@stdlib/array-int32' ); var copy = require( '@stdlib/utils-copy' ); var arr = [ { 'x': new Date(), 'y': [ randu(), randu() ], 'z': new Int32Array( [ 1, 2, 3, 4 ] ), 'label': 'Beep' }, { 'x': new Date(), 'y': [ randu(), randu() ], 'z': new Int32Array( [ 3, 1, 2, 4 ] ), 'label': 'Boop' } ]; // Perform a full deep copy: var out = copy( arr ); var bool = ( arr[ 0 ] === out[ 0 ] ); // returns false bool = ( arr[ 1 ].y === out[ 1 ].y ); // returns false // Perform a shallow copy: out = copy( arr, 1 ); bool = ( arr[ 0 ] === out[ 0 ] ); // returns true bool = ( arr[ 1 ].z === out[ 1 ].z ); // returns true ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 33

Last Year

Push event: 33

Committers

Last synced: about 2 years ago

All Time

Total Commits: 65
Total Committers: 2
Avg Commits per committer: 32.5
Development Distribution Score (DDS): 0.2

Past Year

Commits: 15
Committers: 1
Avg Commits per committer: 15.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	52
Philipp Burckhardt	p**t@o**m	13

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 95,174 last-month
Total docker downloads: 481,207,407

Total dependent packages: 182
Total dependent repositories: 214
Total versions: 11
Total maintainers: 4

npmjs.org: @stdlib/utils-copy

Copy or deep clone a value to an arbitrary depth.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 11
Dependent Packages: 182
Dependent Repositories: 214
Downloads: 95,174 Last month
Docker Downloads: 481,207,407

Rankings

Docker downloads count: 0.1%

Dependent packages count: 0.2%

Downloads: 0.7%

Dependent repos count: 1.1%

Average: 5.7%

Forks count: 15.4%

Stargazers count: 16.7%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

Dependencies

package.json npm

@stdlib/assert-has-class-support ^0.0.x development
@stdlib/assert-has-map-support ^0.0.x development
@stdlib/assert-has-set-support ^0.0.x development
@stdlib/assert-is-node ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/boolean-ctor ^0.0.x development
@stdlib/buffer-ctor ^0.0.x development
@stdlib/buffer-from-array ^0.0.x development
@stdlib/constants-float64-pi ^0.0.x development
@stdlib/number-ctor ^0.0.x development
@stdlib/process-env ^0.0.x development
@stdlib/random-base-randu ^0.0.x development
@stdlib/utils-noop ^0.0.x development
chai ^3.5.0 development
istanbul ^0.4.1 development
semver ^6.0.0 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-float32 ^0.0.x
@stdlib/array-float64 ^0.0.x
@stdlib/array-int16 ^0.0.x
@stdlib/array-int32 ^0.0.x
@stdlib/array-int8 ^0.0.x
@stdlib/array-uint16 ^0.0.x
@stdlib/array-uint32 ^0.0.x
@stdlib/array-uint8 ^0.0.x
@stdlib/array-uint8c ^0.0.x
@stdlib/assert-has-own-property ^0.0.x
@stdlib/assert-is-array ^0.0.x
@stdlib/assert-is-buffer ^0.0.x
@stdlib/assert-is-error ^0.0.x
@stdlib/assert-is-nonnegative-integer ^0.0.x
@stdlib/buffer-from-buffer ^0.0.x
@stdlib/constants-float64-pinf ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/utils-define-property ^0.0.x
@stdlib/utils-get-prototype-of ^0.0.x
@stdlib/utils-index-of ^0.0.x
@stdlib/utils-keys ^0.0.x
@stdlib/utils-property-descriptor ^0.0.x
@stdlib/utils-property-names ^0.0.x
@stdlib/utils-regexp-from-string ^0.0.x
@stdlib/utils-type-of ^0.0.x

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

@stdlib/utils-copy

Science Score: 44.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Copy

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/utils-copy

Rankings

Maintainers (4)

Funding

Dependencies