Symbol.iterator

よく知られたSymbol.iteratorシンボルはオブジェクトに対するデフォルトイテレータを指定します。for...ofによって使われます。

説明

(for..ofループの始まりのときのように)オブジェクトが反復される必要があるときはいつでも、@@iterator メソッドは引数なしで呼ばれます。返されたiteratorは反復される値を取得するために使用されます。

デフォルトの反復動作を持っている組み込み型もあれば、(Objectのような)持っていない型もあります。@@iteratorメソッドをもつ組み込み型は下記の通りです。:

• Array.prototype[@@iterator]()
• TypedArray.prototype[@@iterator]()
• String.prototype[@@iterator]()
• Map.prototype[@@iterator]()
• Set.prototype[@@iterator]()

詳細については、 Iteration protocolsも確かめて下さい。

例

ユーザ定義イテレータ

このように独自のイテレータを作ることができます。:

var myIterable = {}
myIterable[Symbol.iterator] = function* () {
    yield 1;
    yield 2;
    yield 3;
};
[...myIterable] // [1, 2, 3]

非整形イテレータ

iterableの@@iterator メソッドがイテレータオブジェクトを返さない場合、それは非整形イテレータです。そのように使用すると、実行時例外またはバグの動作が発生する可能性があります。:

var nonWellFormedIterable = {}
nonWellFormedIterable[Symbol.iterator] = () => 1
[...nonWellFormedIterable] // TypeError: [] is not a function

仕様

ブラウザ実装状況

関連情報

• Iteration protocols
• Array.prototype[@@iterator]()
• TypedArray.prototype[@@iterator]()
• String.prototype[@@iterator]()
• Map.prototype[@@iterator]()
• Set.prototype[@@iterator]()