aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/javascript/reference/global_objects/set/foreach/index.html
blob: dbab2c1bcc97f30023817ab70d5849742d8f91fa (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: Set.prototype.forEach()
slug: Web/JavaScript/Reference/Global_Objects/Set/forEach
tags:
  - ECMAScript 2015
  - JavaScript
  - Method
  - Prototype
  - Reference
  - set
translation_of: Web/JavaScript/Reference/Global_Objects/Set/forEach
---
<div>{{JSRef}}</div>

<p><strong><code>forEach()</code></strong> メソッドは、与えられた関数を <code>Set</code> オブジェクトの各値に対して一回ずつ、挿入順で実行します。</p>

<div>{{EmbedInteractiveExample("pages/js/set-prototype-foreach.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>mySet</var>.forEach(<var>callback</var>[, <var>thisArg</var>])</pre>

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

<dl>
 <dt><code><var>callback</var></code></dt>
 <dd>各要素に対して実行する関数で、 3つの引数を受け付けます。</dd>
 <dd>
 <dl>
  <dt><code><var>currentValue</var></code>, <code><var>currentKey</var></code></dt>
  <dd><code>Set</code>で現在 処理されている要素。 <code>Set</code> にはキー(key)がないため値(value)が両方に渡されます。</dd>
  <dt><code><var>set</var></code></dt>
  <dd><code>forEach()</code> が呼ばれている <code>Set</code> オブジェクト</dd>
 </dl>
 </dd>
 <dt><code><var>thisArg</var></code></dt>
 <dd><code><var>callback</var></code> を実行するとき、<code>this</code> として使用する値です。</dd>
</dl>

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

<p>{{jsxref("undefined")}} です。</p>

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

<p><code>forEach()</code> メソッドは <code>Set</code> オブジェクトに実際に存在する各値に対して一回、与えられた <code><var>callback</var></code> を実行します。削除された値に対しては呼び出されません。ですが、<code>undefined</code> の値をもつ要素に対しては実行されます。</p>

<p><code><var>callback</var></code><strong>3つの引数</strong>で呼び出されます。</p>

<ul>
 <li><strong>要素値</strong></li>
 <li><strong>要素キー</strong></li>
 <li><strong>対象となる <code>Set</code> オブジェクト</strong></li>
</ul>

<p><code>Set</code> オブジェクトにキーはありません。しかし、最初の 2 つの引数は、両方とも {{jsxref("Set")}} に含まれる<strong></strong>です。そのため <code><var>callback</var></code> 関数は {{jsxref("Map.foreach", "Map")}}{{jsxref("Array.forEach","Array")}}<code>forEach()</code> メソッドと矛盾がありません。</p>

<p><code><var>thisArg</var></code> 引数が <code>forEach()</code> に与えられた場合、呼び出されたときに <code>this</code> 値として使用するために <code><var>callback</var></code> に渡されます。さもなければ、<code>this</code> 値として使用するために <code>undefined</code> 値が渡されます。<code><var>callback</var></code> によって最終的に観測可能な <code>this</code> 値は<a href="/ja/docs/Web/JavaScript/Reference/Operators/this">関数から見た <code>this</code> を決定するための通常のルール</a>に応じて決定されます。</p>

<p>各値は一度だけ訪問されますが、 <code>forEach()</code> が終了する前に削除・再追加された場合は例外です。 到達する前に削除された値に対しては <code><var>callback</var></code> は実行されません。 <code>forEach()</code> が終了する前に追加された新規の値は訪問されます。</p>

<p><code>forEach()</code><code>Set</code> オブジェクト内の各要素に対して一回 <code><var>callback</var></code> 関数を実行します。<code>forEach()</code> は値を返しません。</p>

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

<h3 id="Logging_the_contents_of_a_Set_object" name="Logging_the_contents_of_a_Set_object">Set オブジェクトの内容を出力する</h3>

<p>次のコードでは、<code>Set</code> オブジェクト内の各要素に対してログを出力します。</p>

<pre class="brush:js notranslate">function logSetElements(value1, value2, set) {
    console.log('s[' + value1 + '] = ' + value2);
}

new Set(['foo', 'bar', undefined]).forEach(logSetElements);

// logs:
// "s[foo] = foo"
// "s[bar] = bar"
// "s[undefined] = undefined"
</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-set.prototype.foreach', 'Set.prototype.forEach')}}</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2>

<p>{{Compat("javascript.builtins.Set.forEach")}}</p>

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

<ul>
 <li>{{jsxref("Array.prototype.forEach()")}}</li>
 <li>{{jsxref("Map.prototype.forEach()")}}</li>
</ul>