aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/javascript/reference/global_objects/array/unshift/index.html
blob: cd4c85714a77c1c8ae823607457950e24650792a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
---
title: Array.prototype.unshift()
slug: Web/JavaScript/Reference/Global_Objects/Array/unshift
tags:
  - Array
  - JavaScript
  - Method
  - Prototype
  - Reference
translation_of: Web/JavaScript/Reference/Global_Objects/Array/unshift
---
<div>{{JSRef}}</div>

<p><code><strong>unshift()</strong></code> メソッドは、配列の最初に 1 つ以上の要素を追加し、新しい配列の長さを返します。</p>

<div>{{EmbedInteractiveExample("pages/js/array-unshift.html")}}</div>

<h2 id="Syntax" name="Syntax">構文</h2>

<pre class="syntaxbox notranslate"><var>arr</var>.unshift(<var>element1</var>[, ...[, <var>elementN</var>]])</pre>

<h3 id="Parameters" name="Parameters">引数</h3>

<dl>
 <dt><code>element<em>N</em></code></dt>
 <dd><code><var>arr</var></code> の先頭に追加する要素。</dd>
</dl>

<h3 id="Return_value" name="Return_value">返値</h3>

<p>メソッドを呼び出した後のオブジェクトの新しい {{jsxref("Array.length", "length")}} プロパティの値です。</p>

<h2 id="Description" name="Description">解説</h2>

<p><code>unshift</code> メソッドは、与えられた要素を配列のようなオブジェクトの一番最初に挿入します。</p>

<p><code>unshift</code> は意図して汎用的です。このメソッドは,配列に類似したオブジェクトに対して{{jsxref("Function.call", "呼び出し", "", 1)}}たり,{{jsxref("Function.apply", "適用し", "", 1)}}たりすることができます。 <code>length</code> プロパティ、すなわち連続の最後を示すゼロベースの数値プロパティ、を反映しているため、意味のある振る舞いができない可能性があります。</p>

<p>複数の要素が引数として渡された場合、引数として渡されたものと全く同じ順番で、オブジェクトの最初のチャンクに挿入されることに注意してください。したがって、 <code>unshift</code><code><var>n</var></code> 個の引数で1回呼び出すのと、1個の引数で <code><var>n</var></code> 回 (例えばループを使って) 呼び出すのとでは同じ結果にはなりません。</p>

<p>例をご覧ください。</p>

<pre class="syntaxbox notranslate">let arr = [4, 5, 6]

arr.unshift(1, 2, 3)
console.log(arr);
// [<strong>1, 2, 3</strong>, 4, 5, 6]

arr = [4, 5, 6] // 配列をリセット

arr.unshift(1)
arr.unshift(2)
arr.unshift(3)

console.log(arr)
// [<strong>3, 2, 1</strong>, 4, 5, 6]
</pre>

<h2 id="Examples" name="Examples"></h2>

<h3 id="Using_unshift" name="Using_unshift">unshift の使用</h3>

<pre class="brush: js notranslate">let arr = [1, 2]

arr.unshift(0)               // 呼び出しの返値は 3、新しい配列の長さ
// arr is [0, 1, 2]

arr.unshift(-2, -1)          // 新しい配列の長さは 5
// arr is [-2, -1, 0, 1, 2]

arr.unshift([-4, -3])        // 新しい配列の長さは 6
// arr is [[-4, -3], -2, -1, 0, 1, 2]

arr.unshift([-7, -6], [-5])  // 新しい配列の長さは 8
// arr is [ [-7, -6], [-5], [-4, -3], -2, -1, 0, 1, 2 ]
</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.unshift', 'Array.prototype.unshift')}}</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.unshift")}}</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.shift()")}}</li>
 <li>{{jsxref("Array.prototype.concat()")}}</li>
</ul>