Symbol.iterator

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

このデモのソースファイルは GitHub リポジトリに格納されています。デモプロジェクトに協力したい場合は、 https://github.com/mdn/interactive-examples をクローンしてプルリクエストを送信してください。

解説

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

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

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

詳細については、反復処理プロトコルも確認してください。

例

ユーザー定義イテレーター

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

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

仕様書

ブラウザーの対応

関連情報

• 反復処理プロトコル
• Array.prototype[@@iterator]()
• TypedArray.prototype[@@iterator]()
• String.prototype[@@iterator]()
• Map.prototype[@@iterator]()
• Set.prototype[@@iterator]()