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