factory.js (1793B)
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 // MODULES // 22 23 var copy = require( './../../copy' ); 24 var validate = require( './validate.js' ); 25 var defaults = require( './defaults.js' ); 26 var mergefcn = require( './mergefcn.js' ); 27 28 29 // MAIN // 30 31 /** 32 * Returns a function for merging and extending objects. 33 * 34 * @param {Options} options - merge options 35 * @param {number} [options.level=Infinity] - merge level 36 * @param {boolean} [options.copy=true] - boolean indicating whether to deep copy merged values 37 * @param {(boolean|Function)} [options.override=true] - defines the merge strategy 38 * @param {boolean} [options.extend=true] - boolean indicating whether new properties can be added to the target object 39 * @throws {TypeError} must provide valid options 40 * @returns {Function} function which can be used to merge objects 41 * 42 * @example 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 function factory( options ) { 54 var opts; 55 var err; 56 opts = copy( defaults ); 57 err = validate( opts, options ); 58 if ( err ) { 59 throw err; 60 } 61 return mergefcn( opts ); 62 } 63 64 65 // EXPORTS // 66 67 module.exports = factory;