Array.shift

概要

配列から最初の要素を取り除き、その要素を返します。このメソッドは配列の長さを変えます。

Array のメソッド
実装されたバージョン	JavaScript 1.2, NES 3.0
ECMAScript エディション	ECMA-262 Edition 3

構文

array.shift()

説明

shift メソッドは 0 番目の添え字の要素を取り除き、続く添え字の値を小さい方向にずらします。そして、削除された値を返します。

shift は意図して汎用的です。つまり、このメソッドは配列に類似したオブジェクトに対して call したり、apply したりすることができます。ゼロから始まる数値プロパティであり、連続した連なりの最後を反映している length プロパティを含まないオブジェクトでは効果がないかもしれません。

例

例: 配列から要素を取り除く

以下のコードは myFish 配列を、その最初の要素を取り除く前後で表示します。また、取り除いた要素も表示します。

// println 関数が定義されていると仮定
var myFish = ["angel", "clown", "mandarin", "surgeon"];

println("myFish 処理前: " + myFish);

var shifted = myFish.shift();

println("myFish 処理後: " + myFish);
println("取り除いた要素: " + shifted);

この例は以下のように表示されます。

myFish 処理前: ["angel", "clown", "mandarin", "surgeon"]
myFish 処理後: ["clown", "mandarin", "surgeon"]
取り除いた要素: angel

関連情報

• pop、 push、 unshift