Scroll to navigation

Array.shift(3kaya) Kaya module reference Array.shift(3kaya)

NAME

Array::shift - Get the first item off an array, and remove it from the array.

SYNOPSIS

a shift( var [a] array )

ARGUMENTS

array The array

DESCRIPTION

Get the first item off an array, and remove it from the array.

array = [1,2,3];
v = shift(array);
// array = [2,3]; v = 1;

AUTHORS

Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/

LICENSE

The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.

RELATED

Array.push (3kaya)
Array.pop (3kaya)
Array.removeAt (3kaya)
Array.unshift (3kaya)
August 2014 Kaya