flatten.js (1425B)
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 recurse = require( './recurse.js' ); 25 26 27 // MAIN // 28 29 /** 30 * Flattens an object. 31 * 32 * @private 33 * @param {ObjectLike} obj - object to flatten 34 * @param {Object} opts - options 35 * @param {NonNegativeInteger} opts.depth - maximum depth to flatten 36 * @param {boolean} opts.copy - boolean indicating whether to deep copy 37 * @param {boolean} opts.flattenArrays - boolean indicating whether to flatten arrays 38 * @param {string} opts.delimiter - key path delimiter 39 * @returns {Object} flattened object 40 */ 41 function flatten( obj, opts ) { 42 var out; 43 if ( opts.depth === 0 ) { 44 out = obj; 45 } else { 46 out = recurse( {}, obj, '', opts.depth, opts ); 47 } 48 if ( opts.copy ) { 49 return copy( out ); 50 } 51 return out; 52 } 53 54 55 // EXPORTS // 56 57 module.exports = flatten;