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

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
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
2x
2x
2x
2x
2x
2x
2x
2x
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';
 
/**
* Return a new array containing every element from an input array, with a provided value inserted at a specified index.
*
* @module @stdlib/array/base/to-inserted-at
*
* @example
* var toInsertedAt = require( '@stdlib/array/base/to-inserted-at' );
*
* var x = [ 1, 2, 3, 4 ];
*
* var v = toInsertedAt( x, 0, 5 );
* // returns [ 5, 1, 2, 3, 4 ]
*
* v = toInsertedAt( x, -2, -1 );
* // returns [ 1, 2, 3, -1, 4 ]
*
* @example
* var toInsertedAt = require( '@stdlib/array/base/to-inserted-at' );
*
* var x = [ 1, 2, 3, 4 ];
*
* var out = [ 0, 0, 0, 0 ];
* var arr = toInsertedAt.assign( x, 0, 5, out, 1, 0 );
* // returns [ 5, 1, 2, 3, 4 ]
*
* var bool = ( arr === out );
* // returns true
*/
 
// MODULES //
 
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var main = require( './main.js' );
var assign = require( './assign.js' );
 
 
// MAIN //
 
setReadOnly( main, 'assign', assign );
 
 
// EXPORTS //
 
module.exports = main;