index.js (1443B)
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 * Merge and extend objects. 23 * 24 * @module @stdlib/utils/merge 25 * 26 * @example 27 * var merge = require( '@stdlib/utils/merge' ); 28 * 29 * var target = { 30 * 'a': 'beep' 31 * }; 32 * var source = { 33 * 'a': 'boop', 34 * 'b': 'bap' 35 * }; 36 * 37 * var out = merge( target, source ); 38 * // returns {'a':'boop', 'b':'bap'} 39 * 40 * @example 41 * var factory = require( '@stdlib/utils/merge' ).factory; 42 * 43 * var opts = { 44 * 'level': 100, 45 * 'copy': true, 46 * 'override': true, 47 * 'extend': true 48 * }; 49 * 50 * var merge = factory( opts ); 51 * // returns <Function> 52 */ 53 54 // MODULES // 55 56 var setReadOnly = require( './../../define-nonenumerable-read-only-property' ); 57 var merge = require( './merge.js' ); 58 var factory = require( './factory.js' ); 59 60 61 // MAIN // 62 63 setReadOnly( merge, 'factory', factory ); 64 65 66 // EXPORTS // 67 68 module.exports = merge;