handler.enumerate()

構文

var p = new Proxy(target, {
  enumerate(target) {
  }
});

引数

次の引数がenumerate メソッドに渡されます。thisはハンドラにバインドされます。

target

ターゲットオブジェクト

戻り値

enumerate メソッドはiterator オブジェクトを返さなければなりません。

説明

handler.enumerate メソッドはfor...in 文に対するトラップです。

妨害

このトラップは下記の操作を妨害できます。:

• Property enumeration / for...in: for (var name in proxy) {...}
• Reflect.enumerate()

不変条件

次の不変条件に違反している場合、ProxyはTypeErrorをスローします。:

• enumerate メソッドはオブジェクトを返さなければなりません。

例

次のコードではfor...in 文をトラップします。

var p = new Proxy({}, {
  enumerate(target) {
    console.log("called");
    return ["a", "b", "c"][Symbol.iterator]();
  }
});

for (var x in p) { // "called"
  console.log(x);  // "a"
}                  // "b"
                   // "c"

次のコードでは不変条件に違反します。

var p = new Proxy({}, {
  enumerate(target) {
    return 1;
  }
});

for (var x in p) {} // TypeError is thrown

注意: 両方の例ではメソッド定義に対してショートハンドを使用しています。

仕様

ブラウザ実装状況

関連情報

• Proxy
• handler
• for...in statements
• Reflect.enumerate()