index.js (1233B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Copy or deep clone a value to an arbitrary depth. 23 * 24 * @module @stdlib/utils/copy 25 * 26 * @example 27 * var copy = require( '@stdlib/utils/copy' ); 28 * 29 * var out = copy( 'beep' ); 30 * // returns 'beep' 31 * 32 * @example 33 * var copy = require( '@stdlib/utils/copy' ); 34 * 35 * var value = [ 36 * { 37 * 'a': 1, 38 * 'b': true, 39 * 'c': [ 1, 2, 3 ] 40 * } 41 * ]; 42 * var out = copy( value ); 43 * // returns [ {'a': 1, 'b': true, 'c': [ 1, 2, 3 ] } ] 44 * 45 * var bool = ( value[0].c === out[0].c ); 46 * // returns false 47 */ 48 49 // MODULES // 50 51 var copy = require( './copy.js' ); 52 53 54 // EXPORTS // 55 56 module.exports = copy;