diff options
Diffstat (limited to 'files/ja/web/javascript/reference/global_objects/array/shift/index.html')
-rw-r--r-- | files/ja/web/javascript/reference/global_objects/array/shift/index.html | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/files/ja/web/javascript/reference/global_objects/array/shift/index.html b/files/ja/web/javascript/reference/global_objects/array/shift/index.html new file mode 100644 index 0000000000..5dff35d03f --- /dev/null +++ b/files/ja/web/javascript/reference/global_objects/array/shift/index.html @@ -0,0 +1,98 @@ +--- +title: Array.prototype.shift() +slug: Web/JavaScript/Reference/Global_Objects/Array/shift +tags: + - Array + - JavaScript + - Method + - Prototype + - Reference +translation_of: Web/JavaScript/Reference/Global_Objects/Array/shift +--- +<div>{{JSRef}}</div> + +<p><strong><code>shift()</code></strong> メソッドは、配列から<strong>最初</strong>の要素を取り除き、その要素を返します。このメソッドは配列の長さを変えます。</p> + +<div>{{EmbedInteractiveExample("pages/js/array-shift.html")}}</div> + +<div class="hidden">このデモのソースファイルは GitHub リポジトリに格納されています。デモプロジェクトに協力したい場合は、 <a href="https://github.com/mdn/interactive-examples">https://github.com/mdn/interactive-examples</a> をクローンしてプルリクエストを送信してください。</div> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox notranslate"><var>arr</var>.shift()</pre> + +<h3 id="Return_value" name="Return_value">返値</h3> + +<p>配列から取り除かれた要素を返します。配列が空の場合は、{{jsxref("undefined")}} を返します。</p> + +<h2 id="Description" name="Description">解説</h2> + +<p><code>shift</code> メソッドは 0 番目の添え字の要素を取り除き、続く添え字の値を小さい方向にずらします。そして、削除された値を返します。{{jsxref("Array.length", "length")}} プロパティが 0 の場合、{{jsxref("undefined")}} を返します。</p> + +<p><code>shift</code> は意図的に汎用性を持たせています。つまり、このメソッドは配列に類似したオブジェクトに対して{{jsxref("Function.call", "呼び出し", "", 1)}}たり、{{jsxref("Function.apply", "適用し", "", 1)}}たりすることもできます。ゼロから始まる数値プロパティであり、連続した連なりの最後を反映している <code>length</code> プロパティを含まないオブジェクトでは効果がないかもしれません。</p> + +<p>{{jsxref("Array.prototype.pop()")}} は <code>shift</code> と似た動作をしますが、配列の最後の要素に適用されます。</p> + +<h2 id="Examples" name="Examples">例</h2> + +<h3 id="Removing_an_element_from_an_array" name="Removing_an_element_from_an_array">配列から要素を除去</h3> + +<p>以下のコードは <code>myFish</code> 配列を、その最初の要素を取り除く前後で表示します。また、取り除いた要素も表示します。</p> + +<pre class="brush: js notranslate">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 +</pre> + +<h3 id="shift_メソッドの_while_ループ内での使用する">shift() メソッドの while ループ内での使用する</h3> + +<p>shift() メソッドは時に、 while 文の条件内において用いられます。以下のコードでは、要素がすべて無くなるまで、各くり返し内でその配列内の次の要素を取り除きます。</p> + +<pre class="brush: js notranslate">var names = ["Andrew", "Edward", "Paul", "Chris" ,"John"]; + +while( (i = names.shift()) !== undefined ) { + console.log(i); +} +// Andrew, Edward, Paul, Chris, John +</pre> + +<h2 id="Specifications" name="Specifications">仕様書</h2> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">仕様書</th> + </tr> + </thead> + <tbody> + <tr> + <td>{{SpecName('ESDraft', '#sec-array.prototype.shift', 'Array.prototype.shift')}}</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + +<div> +<div class="hidden">このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 <a class="external" href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックアウトしてプルリクエストを送信してください。</div> + +<p>{{Compat("javascript.builtins.Array.shift")}}</p> +</div> + +<h2 id="See_also" name="See_also">関連情報</h2> + +<ul> + <li>{{jsxref("Array.prototype.push()")}}</li> + <li>{{jsxref("Array.prototype.pop()")}}</li> + <li>{{jsxref("Array.prototype.unshift()")}}</li> + <li>{{jsxref("Array.prototype.concat()")}}</li> +</ul> |