# unshift
> Add one or more elements to the beginning of a collection.
## Usage
```javascript
var unshift = require( '@stdlib/utils/unshift' );
```
#### unshift( collection, ...items )
Adds one or more elements to the beginning of a `collection`. A `collection` may be either an [`Array`][mdn-array], [`Typed Array`][mdn-typed-array], or an array-like [`Object`][mdn-object] (i.e., an [`Object`][mdn-object] having a valid writable `length` property).
```javascript
var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
var out = unshift( arr, 6.0, 7.0 );
// returns [ 6.0, 7.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]
var bool = ( out === arr );
// returns true
```
In contrast to [`Array.prototype.unshift`][mdn-array-unshift], the function returns the extended collection, rather than the collection length. For [typed arrays][mdn-typed-array], the returned value is a new [typed array][mdn-typed-array] view whose underlying [`ArrayBuffer`][mdn-arraybuffer] may **not** equal the underlying [`ArrayBuffer`][mdn-arraybuffer] for the input `collection`.
```javascript
var ArrayBuffer = require( '@stdlib/array/buffer' );
var Float64Array= require( '@stdlib/array/float64' );
var buf = new ArrayBuffer( 3*8 ); // 8 bytes per double
var arr = new Float64Array( buf, 8, 2 );
arr[ 0 ] = 1.0;
arr[ 1 ] = 2.0;
var out = unshift( arr, 3.0 );
// returns [ 3.0, 1.0, 2.0 ]
var bool = ( out === arr );
// returns false
bool = ( out.buffer === arr.buffer );
// returns true
out = unshift( out, 4.0 );
// returns [ 4.0, 3.0, 1.0, 2.0 ]
bool = ( out.buffer === arr.buffer );
// returns false
```
## Notes
- The function adds one or more elements to a [typed array][mdn-typed-array] by setting values in the underlying [`ArrayBuffer`][mdn-arraybuffer]. If an [`ArrayBuffer`][mdn-arraybuffer] does not have enough bytes in which to store all elements, the function allocates a new [`ArrayBuffer`][mdn-arraybuffer] capable of holding `2^n` elements, where `n` is the next power of `2`. This procedure is similar to how environments internally handle dynamic memory allocation for [`Arrays`][mdn-array].
- Beware when providing [typed arrays][mdn-typed-array] which are views pointing to a shared (or pooled) [`ArrayBuffer`][mdn-arraybuffer]. Because the function sets [`ArrayBuffer`][mdn-arraybuffer] bytes outside of a provided [view][mdn-typed-array], the function may overwrite bytes belonging to one or more external views. This could be a potential **security vulnerability**. Prefer providing [typed arrays][mdn-typed-array] which have an exclusive [`ArrayBuffer`][mdn-arraybuffer]; otherwise, be sure to plan for and guard against mutated state.
## Examples
```javascript
var Float64Array= require( '@stdlib/array/float64' );
var unshift = require( '@stdlib/utils/unshift' );
var arr;
var i;
arr = new Float64Array();
for ( i = 0; i < 100; i++ ) {
arr = unshift( arr, i );
}
console.log( arr );
```
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
[mdn-array-unshift]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/unshift
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays
[mdn-arraybuffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
[mdn-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object