All files / array/base/to-inserted-at/lib main.js

100% Statements 68/68
100% Branches 5/5
100% Functions 1/1
100% Lines 68/68

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 692x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 54x 54x 54x 54x 54x 36x 36x 54x 54x 54x 54x 2x 2x 2x 2x 2x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var zeros = require( '@stdlib/array/zeros' );
var dtype = require( '@stdlib/array/dtype' );
var format = require( '@stdlib/string/format' );
var assign = require( './assign.js' );
 
 
// MAIN //
 
/**
* Returns a new array containing every element from an input array, with a provided value inserted at a specified index.
*
* @param {Collection} x - input array
* @param {integer} index - element index
* @param {*} value - value to insert
* @throws {RangeError} second argument must not exceed array bounds
* @returns {Collection} output array
*
* @example
* var x = [ 1, 2, 3, 4 ];
*
* var v = toInsertedAt( x, 0, 5 );
* // returns [ 5, 1, 2, 3, 4 ]
*
* v = toInsertedAt( x, 1, 6 );
* // returns [ 1, 6, 2, 3, 4 ]
*
* v = toInsertedAt( x, -2, 7 );
* // returns  [ 1, 2, 7, 3, 4 ]
*/
function toInsertedAt( x, index, value ) {
	var out;
 
	index = normalizeIndex( index, x.length-1 );
	if ( index < 0 ) {
		throw new RangeError( format( 'invalid argument. Index argument is out-of-bounds. Value: `%d`.', index ) );
	}
	out = zeros( x.length+1, dtype( x ) || 'generic' );
	assign( x, index, value, out, 1, 0 );
	return out;
}
 
 
// EXPORTS //
 
module.exports = toInsertedAt;