handler.ownKeys()

概要

Object.getOwnPropertyNames()に対するトラップです。

構文

var p = new Proxy(target, {
  ownKeys: function(target) {
  }
});

引数

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

target

ターゲットオブジェクト

戻り値

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

説明

handler.ownKeys() メソッドはObject.getOwnPropertyNames()に対するトラップです。

インターセプト

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

• Object.getOwnPropertyNames()
• Object.getOwnPropertySymbols()
• Object.keys()
• Reflect.ownKeys()

不変条件

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

• ownKeysの結果はリストです。
• 結果リストのそれぞれの要素の型はString または Symbolのどちらかです。
• 結果リストはターゲットオブジェクトのすべての非設定の独自プロパティのキーを含みます。
• ターゲットオブジェクトが拡張可能でないなら、結果リストはターゲットオブジェクトのすべての独自プロパティのキーを含まなければなりません。そして、他の値を含みません。

例

次のコードではObject.getOwnPropertyNames()をトラップします。

var p = new Proxy({}, {
  ownKeys: function(target) {
    console.log("called");
    return ["a", "b", "c"];
  }
});

console.log(Object.getOwnPropertyNames(p)); // "called"

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

var obj = {};
Object.defineProperty(obj, "a", { 
  configurable: false, 
  enumerable: true, 
  value: 10 }
);

var p = new Proxy(obj, {
  ownKeys: function(target) {
    return [];
  }
});

console.log(Object.getOwnPropertyNames(p)); // TypeError is thrown

仕様

ブラウザ実装状況

関連情報

• Proxy
• handler
• Object.getOwnPropertyNames()
• Reflect.ownKeys()