→
その Array から、最初の要素を取り除き、その要素を返します。
元の配列は変更され、配列の長さも変わります。
Array | Arrayオブジェクト |
---|
配列から取り除かれた要素を返します。配列が空の場合は、undefined を返します。
shift メソッドは 0 番目の添え字の要素を取り除き、続く添え字の値を小さい方向にずらします。そして、削除された値を返します。length プロパティが 0 の場合、undefined を返します。
shift は意図的に汎用性を持たせています。つまり、このメソッドは配列に類似したオブジェクトに対して呼び出したり、適用したりすることもできます。ゼロから始まる数値プロパティであり、連続した連なりの最後を反映している length プロパティを含まないオブジェクトでは効果がないかもしれません。
Array.prototype.pop() は shift と似た動作をしますが、配列の最後の要素に適用されます。
以下のコードは myFish 配列を、その最初の要素を取り除く前後で表示します。また、取り除いた要素も表示します。
コンソールにて var myFish = ['angel', 'clown', 'mandarin', 'surgeon']; console.log('myFish before:', JSON.stringify(myFish)); // myFish 処理前: ['angel', 'clown', 'mandarin', 'surgeon'] var shifted = myFish.shift(); console.log('myFish 処理後:', myFish); // myFish 処理後: ['clown', 'mandarin', 'surgeon'] console.log('取り除いた要素:', shifted); // 取り除いた要素: angel
shift() メソッドは時に、while 文の条件内において用いられます。以下のコードでは、要素がすべて無くなるまで、各くり返し内でその配列内の次の要素を取り除きます。
var names = ["Andrew", "Edward", "Paul", "Chris" ,"John"]; while( (i=names.shift()) !== undefined ) { alert(i); }
表示結果:
"Andrew"、"Edward"、"Paul"、"Chris"、"John"