aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/javascript/reference/global_objects/array/observe/index.html
blob: e480baf2e3002d512880beeac440e3978a20f211 (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
---
title: Array.observe()
slug: Web/JavaScript/Reference/Global_Objects/Array/observe
tags:
  - Array
  - JavaScript
  - Method
  - Obsolete
translation_of: Archive/Web/JavaScript/Array.observe
---
<div>{{JSRef}} {{obsolete_header}}</div>

<p><strong><code>Array.observe()</code></strong> メソッドは、配列への変更を非同期で監視するために使用されました。オブジェクト用の {{jsxref("Object.observe()")}} と似ています。変更内容は、発生した順番に時系列で提供されます。accept type list <code>["add", "update", "delete", "splice"]</code> で呼び出された <code>Object.observe()</code> と同等です。しかしながら、この API の使用は非推奨となり、ブラウザから削除されています。代わりに、一般的な {{jsxref("Proxy")}} オブジェクトを使用してください。</p>

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

<pre class="syntaxbox">Array.observe(<var>arr</var>, <var>callback</var>)</pre>

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

<dl>
 <dt><code>arr</code></dt>
 <dd>監視される配列。</dd>
 <dt><code>callback</code></dt>
 <dd>変更されるたびに毎回呼び出される関数。次の引数を持ちます:
 <dl>
  <dt><code>changes</code></dt>
  <dd>変更されたオブジェクトの配列。変更オブジェクトのプロパティは次の通り:
  <ul>
   <li><strong><code>name</code></strong>: 変更されたプロパティの名前。</li>
   <li><strong><code>object</code></strong>: 変更後の配列。</li>
   <li><strong><code>type</code></strong>: 変更の種類を示す文字列。 <code>"add"</code>, <code>"update"</code>, <code>"delete"</code>, <code>"splice"</code> のいずれか一つ。</li>
   <li><strong><code>oldValue</code></strong>: <code>"update"</code>, <code>"delete"</code> の場合のみ、変更前の値。</li>
   <li><strong><code>index</code></strong>: <code>"splice"</code> の場合のみ。変更が発生したインデックス。</li>
   <li><strong><code>removed</code></strong>: <code>"splice"</code> の場合のみ。取り除かれた要素の配列。</li>
   <li><strong><code>addedCount</code></strong>: <code>"splice"</code> の場合のみ。追加された要素の数。</li>
  </ul>
  </dd>
 </dl>
 </dd>
</dl>

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

<p><code>callback</code> 関数は、<code>arr</code> に変更が発生する度に呼ばれます。すべての変更が発生した順に配列として渡されます。</p>

<div class="note">
<p><a href="/docs/Web/JavaScript/Reference/Global_Objects/Array/pop"><code>Array.prototype.pop()</code></a> など、Array メソッド経由の変更は、<code>"splice"</code> 変更として報告されます。配列の長さが変更されないインデックスの割り当て変更は、<code>"update"</code> 変更として報告されます。</p>
</div>

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

<h3 id='="Logging_different_change_types"' name='="Logging_different_change_types"'>異なる変更のログを取る</h3>

<pre class="brush: js">var arr = ['a', 'b', 'c'];

Array.observe(arr, function(changes) {
  console.log(changes);
});

arr[1] = 'B';
// [{type: 'update', object: , name: '1', oldValue: 'b'}]

arr[3] = 'd';
// [{type: 'splice', object: , index: 3, removed: [], addedCount: 1}]

arr.splice(1, 2, 'beta', 'gamma', 'delta');
// [{type: 'splice', object: , index: 1, removed: ['B', 'c', 'd'], addedCount: 3}]
</pre>

<h2 id="Specifications" name="Specifications">仕様</h2>

<p><a href="https://github.com/arv/ecmascript-object-observe">Strawman proposal specification</a>.</p>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザ実装状況</h2>

<div>
<p>{{Compat("javascript.builtins.Array.observe")}}</p>
</div>

<p> </p>

<h2 id="See_also" name="See_also">関連情報</h2>

<ul>
 <li><a href="//stackoverflow.com/q/29269057/778272">Under what condition would Array.observe's “add” event trigger?</a></li>
 <li>{{jsxref("Array.unobserve()")}} {{obsolete_inline}}</li>
 <li>{{jsxref("Object.observe()")}} {{obsolete_inline}}</li>
</ul>