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
|
---
title: Symbol.iterator
slug: Web/JavaScript/Reference/Global_Objects/Symbol/iterator
translation_of: Web/JavaScript/Reference/Global_Objects/Symbol/iterator
---
<div>{{JSRef}}</div>
<p>O símbolo conhecido <code><strong>Symbol.iterator</strong></code> especifíca o iterador padrão para um objeto. Usado por <a href="/en-US/docs/Web/JavaScript/Reference/Statements/for...of"><code>for...of</code></a>.</p>
<div>{{EmbedInteractiveExample("pages/js/symbol-iterator.html")}}</div>
<h2 id="Descrição">Descrição</h2>
<p>Sempre que um objeto precisa ser iterado (como um começo de um <code>for..of</code> loop), o método <code>@@iterator</code> é chamado sem argumentos, e o <strong>iterador</strong> retornado é usado para obter os valores para serem iterados.</p>
<p>Alguns tipos built-in tem um comportamento padrão de iteração, enquanto outros tipos (assim como {{jsxref("Object")}}) não tem. O tipo built-in com um método <code>@@iterator</code> são:</p>
<ul>
<li>{{jsxref("Array.@@iterator", "Array.prototype[@@iterator]()")}}</li>
<li>{{jsxref("TypedArray.@@iterator", "TypedArray.prototype[@@iterator]()")}}</li>
<li>{{jsxref("String.@@iterator", "String.prototype[@@iterator]()")}}</li>
<li>{{jsxref("Map.@@iterator", "Map.prototype[@@iterator]()")}}</li>
<li>{{jsxref("Set.@@iterator", "Set.prototype[@@iterator]()")}}</li>
</ul>
<p>Veja também <a href="/en-US/docs/Web/JavaScript/Reference/Iteration_protocols">Iteration protocols</a> para mais informação.</p>
<p>{{js_property_attributes(0,0,0)}}</p>
<h2 id="Exemplos">Exemplos</h2>
<h3 id="Iteráveis_definidos_pelo_usuário">Iteráveis definidos pelo usuário</h3>
<p>Podemos fazer nosso próprio iterável dessa forma:</p>
<pre class="brush: js notranslate">var myIterable = {}
myIterable[Symbol.iterator] = function* () {
yield 1;
yield 2;
yield 3;
};
[...myIterable] // [1, 2, 3]
</pre>
<p>Ou iteráveis podem ser definidos diretamente dentro de uma classe ou um objeto usando <a href="/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer#Computed_property_names">computed property</a>:</p>
<pre class="brush: js notranslate">class Foo {
*[Symbol.iterator] () {
yield 1;
yield 2;
yield 3;
}
}
const someObj = {
*[Symbol.iterator] () {
yield 'a';
yield 'b';
}
}
[...new Foo] // [ 1, 2, 3 ]
[...someObj] // [ 'a', 'b' ]
</pre>
<h3 id="Iteráveis_não_bem_formados">Iteráveis não bem formados</h3>
<p>Se um método <code>@@iterator</code> não retornar um objeto iterador, então é um iterável não bem formado. Usando dessa forma é resultará em uma excessão de tempo ou comportamentos com erros:</p>
<pre class="brush: js notranslate">var nonWellFormedIterable = {}
nonWellFormedIterable[Symbol.iterator] = () => 1
[...nonWellFormedIterable] // TypeError: [] is not a function
</pre>
<h2 id="Especificações">Especificações</h2>
<table class="standard-table">
<thead>
<tr>
<th scope="col">Especificação</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{SpecName('ESDraft', '#sec-symbol.iterator', 'Symbol.iterator')}}</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility">Compatibilidade com navegadores</h2>
<p>{{Compat("javascript.builtins.Symbol.iterator")}}</p>
<h2 id="Veja_também">Veja também</h2>
<ul>
<li><a href="/en-US/docs/Web/JavaScript/Reference/Iteration_protocols">Iteration protocols</a></li>
<li>{{jsxref("Array.@@iterator", "Array.prototype[@@iterator]()")}}</li>
<li>{{jsxref("TypedArray.@@iterator", "TypedArray.prototype[@@iterator]()")}}</li>
<li>{{jsxref("String.@@iterator", "String.prototype[@@iterator]()")}}</li>
<li>{{jsxref("Map.@@iterator", "Map.prototype[@@iterator]()")}}</li>
<li>{{jsxref("Set.@@iterator", "Set.prototype[@@iterator]()")}}</li>
</ul>
|
