index.js (1326B)
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 * Add the elements of one collection to the beginning of another collection. 23 * 24 * @module @stdlib/utils/prepend 25 * 26 * @example 27 * var prepend = require( '@stdlib/utils/prepend' ); 28 * var Float64Array = require( '@stdlib/array/float64' ); 29 * 30 * var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; 31 * 32 * arr = prepend( arr, [ 6.0, 7.0 ] ); 33 * // returns [ 6.0, 7.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] 34 * 35 * arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); 36 * // returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ] 37 * 38 * arr = prepend( arr, [ 6.0, 7.0 ] ); 39 * // returns <Float64Array>[ 6.0, 7.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] 40 */ 41 42 // MODULES // 43 44 var prepend = require( './prepend.js' ); 45 46 47 // EXPORTS // 48 49 module.exports = prepend;