@stdlib/utils
Version:
Standard utilities.
46 lines (34 loc) • 1.21 kB
Plain Text
{{alias}}( collection, ...items )
Adds one or more elements to the end of a collection.
If the input collection is a typed array, the output value does not equal
the input reference and the underlying `ArrayBuffer` may *not* be the same
as the `ArrayBuffer` belonging to the input view.
For purposes of generality, always treat the output collection as distinct
from the input collection.
Parameters
----------
collection: Array|TypedArray|Object
A collection. If the collection is an `Object`, the collection should be
array-like.
items: ...any
Items to add.
Returns
-------
out: Array|TypedArray|Object
Updated collection.
Examples
--------
// Arrays:
> var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
> arr = {{alias}}( arr, 6.0, 7.0 )
[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]
// Typed arrays:
> arr = new {{alias:/array/float64}}( [ 1.0, 2.0 ] );
> arr = {{alias}}( arr, 3.0, 4.0 )
<Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
// Array-like object:
> arr = { 'length': 0 };
> arr = {{alias}}( arr, 1.0, 2.0 )
{ 'length': 2, '0': 1.0, '1': 2.0 }
See Also
--------