time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

wrap_flatten_copy.js (1404B)

      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 isArray = require( '@stdlib/assert/is-array' );
     24 var copy = require( './../../copy' );
     25 
     26 
     27 // MAIN //
     28 
     29 /**
     30 * Returns a function to flatten an array and deep copy.
     31 *
     32 * @private
     33 * @param {Function} flatten - flatten function
     34 * @returns {Function} wrapped flatten function
     35 */
     36 function wrap( flatten ) {
     37 	return flattenArray;
     38 
     39 	/**
     40 	* Flattens an array and deep copies array elements.
     41 	*
     42 	* @private
     43 	* @param {Array} arr - array to flatten
     44 	* @throws {TypeError} must provide an array
     45 	* @returns {Array} flattened array
     46 	*/
     47 	function flattenArray( arr ) {
     48 		if ( !isArray( arr ) ) {
     49 			throw new TypeError( 'invalid argument. Must provide an array. Value: `' + arr + '`.' );
     50 		}
     51 		return copy( flatten( arr ) );
     52 	}
     53 }
     54 
     55 
     56 // EXPORTS //
     57 
     58 module.exports = wrap;