handler.getOwnPropertyDescriptor()

¥Syntax

new Proxy(target, {
  getOwnPropertyDescriptor(target, property) {
  }
})

¥Parameters

以下参数传递给 getOwnPropertyDescriptor() 方法。this 绑定到处理程序。

¥The following parameters are passed to the getOwnPropertyDescriptor() method. this is bound to the handler.

target

目标对象。

property

表示属性名称的字符串或 Symbol。

¥Return value

getOwnPropertyDescriptor() 方法必须返回一个对象或 undefined，表示属性描述符。缺失属性的规范化方式与 Object.defineProperty() 相同。

¥The getOwnPropertyDescriptor() method must return an object or undefined, representing the property descriptor. Missing attributes are normalized in the same way as Object.defineProperty().

¥Description

¥Interceptions

该陷阱可以拦截以下操作：

¥This trap can intercept these operations:

• Object.getOwnPropertyDescriptor()
• Reflect.getOwnPropertyDescriptor()

或调用 [[GetOwnProperty]] 内部方法 的任何其他操作。

¥Or any other operation that invokes the [[GetOwnProperty]] internal method.

¥Invariants

如果处理程序定义违反以下不变量之一，则代理的 [[GetOwnProperty]] 内部方法将抛出 TypeError：

¥The proxy's [[GetOwnProperty]] internal method throws a TypeError if the handler definition violates one of the following invariants:

• 结果必须是 Object 或 undefined。
• 如果属性作为目标对象的不可配置自有属性存在，则不能将其报告为不存在。也就是说，如果 Reflect.getOwnPropertyDescriptor() 对 target 上的属性返回 configurable: false，则陷阱不得返回 undefined。
• 如果属性作为不可扩展目标对象的自有属性而存在，则不能将其报告为不存在。也就是说，如果 Reflect.isExtensible() 对目标对象返回 false，则陷阱不得返回 undefined。
• 如果某个属性不是目标对象的自有属性，并且目标对象不可扩展，则不能将该属性报告为存在。也就是说，如果 Reflect.isExtensible() 对目标对象返回 false，而 Reflect.getOwnPropertyDescriptor() 对 target 上的属性返回 undefined，则陷阱必须返回 undefined。
• 除非某个属性是目标对象的不可配置自有属性，则不能将该属性报告为不可配置。也就是说，如果 Reflect.getOwnPropertyDescriptor() 对 target 上的属性返回 undefined 或 configurable: true，则陷阱不得返回 configurable: false。
• 除非某个属性是目标对象的不可配置、不可写的自有属性，否则不能将该属性报告为既不可配置又不可写。也就是说，除了前面的不变量之外，如果 Reflect.getOwnPropertyDescriptor() 对 target 上的属性返回 configurable: false, writable: true，则陷阱不得返回 configurable: false, writable: false。
• 如果某个属性在目标对象上具有相应的属性，则目标对象属性的描述符必须与 descriptor 兼容。也就是说，假装 target 是一个普通对象，则 Object.defineProperty(target, property, resultObject) 不得抛出错误。Object.defineProperty() 参考包含更多信息，但总结一下，当目标属性不可配置时，必须满足以下条件：
  • configurable、enumerable、get 和 set 必须与原始值相同。writable 也必须是原始的，这是由于前一个不变量。
  • 属性必须保留为数据或访问器
  • 只有当 writable 为 true 时，才能更改 value 属性

¥Examples

¥Trapping of getOwnPropertyDescriptor

以下代码捕获 Object.getOwnPropertyDescriptor()。

¥The following code traps Object.getOwnPropertyDescriptor().

const p = new Proxy(
  { a: 20 },
  {
    getOwnPropertyDescriptor(target, prop) {
      console.log(`called: ${prop}`);
      return { configurable: true, enumerable: true, value: 10 };
    },
  },
);

console.log(Object.getOwnPropertyDescriptor(p, "a").value);
// "called: a"
// 10

以下代码违反了不变量。

¥The following code violates an invariant.

const obj = { a: 10 };
Object.preventExtensions(obj);
const p = new Proxy(obj, {
  getOwnPropertyDescriptor(target, prop) {
    return undefined;
  },
});

Object.getOwnPropertyDescriptor(p, "a"); // TypeError is thrown

¥See also

• Proxy
• Proxy() 构造函数
• Object.getOwnPropertyDescriptor()
• Reflect.getOwnPropertyDescriptor()