Array.prototype.unshift()

Summary

The unshift() method adds one or more elements to the beginning of an array and returns the new length of the array.

Syntax

arr.unshift(element1, ..., elementN) 

Parameters

element1, ..., elementN

The elements to add to the front of the array.

Returns

The new length property of the object upon which the method was called.

Description

The unshift method inserts the given values to the beginning of an array-like object.

unshift is intentionally generic; this method can be called or applied to objects resembling arrays. Objects which do not contain a length property reflecting the last in a series of consecutive, zero-based numerical properties may not behave in any meaningful manner.

Examples

var arr = [1, 2];

arr.unshift(0); // result of call is 3, the new array length
// arr is [0, 1, 2]

arr.unshift(-2, -1); // = 5
// arr is [-2, -1, 0, 1, 2]

arr.unshift( [-3] );
// arr is [[-3], -2, -1, 0, 1, 2]

Specifications

Browser compatibility

See also

• Array.prototype.push()
• Array.prototype.pop()
• Array.prototype.shift()