ArrayShift

Removes the first element from an array and returns the removed element.

This method changes the length of the array. If used on an empty array, an exception will be thrown.

Method Signature

ArrayShift(array=[modifiablearray], defaultValue=[any])

Arguments

Argument	Type	Required	Description	Default
array	modifiablearray	true	The array to shift
defaultValue	any	false

Examples

Related

• ArrayAppend

• ArrayAvg

• ArrayClear

• ArrayContains

• ArrayContainsNoCase

• ArrayDelete

• ArrayDeleteAt

• ArrayDeleteNoCase

• ArrayEach

• ArrayEvery

• ArrayFilter

• ArrayFind

• ArrayFindAll

• ArrayFindAllNoCase

• ArrayFindNoCase

• ArrayFirst

• ArrayGetMetadata

• ArrayIndexExists

• ArrayInsertAt

• ArrayIsDefined

• ArrayLast

• ArrayMap

• ArrayMax

• ArrayMedian

• ArrayMerge

• ArrayMid

• ArrayMin

• ArrayNew

• ArrayPop

• ArrayPrepend

• ArrayPush

• ArrayRange

• ArrayReduce

• ArrayReduceRight

• ArrayResize

• ArrayReverse

• ArraySet

• ArraySlice

• ArraySome

• ArraySort

• ArraySplice

• ArraySum

• ArraySwap

• ArrayToList

• ArrayToStruct

• ArrayUnshift