npm install @stdlib/utils-push

Alternatively,

• To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
• If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
• For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

Thebranches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

varpush=require('@stdlib/utils-push');

Adds one or more elements to the end of acollection. Acollection may be either anArray,Typed Array, or an array-likeObject (i.e., anObject having a valid writablelength property).

vararr=[1.0,2.0,3.0,4.0,5.0];varout=push(arr,6.0,7.0);// returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]varbool=(out===arr);// returns true

In contrast toArray.prototype.push, the function returns the extended collection, rather than the collection length. Fortyped arrays, the returned value is a newtyped array view whose underlyingArrayBuffer maynot equal the underlyingArrayBuffer for the inputcollection.

varArrayBuffer=require('@stdlib/array-buffer');varFloat64Array=require('@stdlib/array-float64');varbuf=newArrayBuffer(3*8);// 8 bytes per doublevararr=newFloat64Array(buf,0,2);arr[0]=1.0;arr[1]=2.0;varout=push(arr,3.0);// returns <Float64Array>[ 1.0, 2.0, 3.0 ]varbool=(out===arr);// returns falsebool=(out.buffer===arr.buffer);// returns trueout=push(out,4.0);// returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]bool=(out.buffer===arr.buffer);// returns false

• The function adds one or more elements to atyped array by setting values in the underlyingArrayBuffer. If anArrayBuffer does not have enough bytes in which to store all elements, the function allocates a newArrayBuffer capable of holding2^n elements, wheren is the next power of2. This procedure is similar to how environments internally handle dynamic memory allocation forArrays.
• Beware when providingtyped arrays which are views pointing to a shared (or pooled)ArrayBuffer. Because the function setsArrayBuffer bytes outside of a providedview, the function may overwrite bytes belonging to one or more external views. This could be a potentialsecurity vulnerability. Prefer providingtyped arrays which have an exclusiveArrayBuffer; otherwise, be sure to plan for and guard against mutated state.

• @stdlib/utils-pop:remove and return the last element of a collection.
• @stdlib/utils-shift:remove and return the first element of a collection.
• @stdlib/utils-unshift:add one or more elements to the beginning of a collection.

This package is part ofstdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to developstdlib, see the main projectrepository.

SeeLICENSE.

Copyright © 2016-2025. The StdlibAuthors.