handler.ownKeys()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2016.

Die handler.ownKeys() Methode ist eine Falle für die [[OwnPropertyKeys]] objektinterne Methode, die von Operationen wie Object.keys(), Reflect.ownKeys() usw. verwendet wird.

Probieren Sie es aus

const monster1 = {
  _age: 111,
  [Symbol("secret")]: "I am scared!",
  eyeCount: 4,
};

const handler1 = {
  ownKeys(target) {
    return Reflect.ownKeys(target);
  },
};

const proxy1 = new Proxy(monster1, handler1);

for (const key of Object.keys(proxy1)) {
  console.log(key);
  // Expected output: "_age"
  // Expected output: "eyeCount"
}

Syntax

new Proxy(target, {
  ownKeys(target) {
  }
})

Parameter

Der folgende Parameter wird an die ownKeys() Methode übergeben. this ist an den Handler gebunden.

target: Das Zielobjekt.

Rückgabewert

Die ownKeys() Methode muss ein array-ähnliches Objekt zurückgeben, bei dem jedes Element entweder ein String oder ein Symbol ohne doppelte Elemente ist.

Beschreibung

Abfangmöglichkeiten

Diese Falle kann folgende Operationen abfangen:

Oder jede andere Operation, die die [[OwnPropertyKeys]] interne Methode aufruft.

Invarianten

Die [[OwnPropertyKeys]] interne Methode des Proxys löst einen TypeError aus, wenn die Handler-Definition eine der folgenden Invarianten verletzt:

Das Ergebnis ist ein Object.
Die Liste der Schlüssel enthält keine doppelten Werte.
Der Typ jedes Schlüssels ist entweder ein String oder ein Symbol.
Die Ergebnisliste muss die Schlüssel aller nicht konfigurierbaren eigenen Eigenschaften des Zielobjekts enthalten. Das heißt, für alle Schlüssel, die von Reflect.ownKeys() auf dem Zielobjekt zurückgegeben werden, gilt: Wenn der Schlüssel von Reflect.getOwnPropertyDescriptor() als configurable: false gemeldet wird, muss der Schlüssel in der Ergebnisliste enthalten sein.
Wenn das Zielobjekt nicht erweiterbar ist, muss die Ergebnisliste alle Schlüssel der eigenen Eigenschaften des Zielobjekts und keine anderen Werte enthalten. Das heißt, wenn Reflect.isExtensible() auf target false zurückgibt, muss die Ergebnisliste dieselben Werte enthalten wie das Ergebnis von Reflect.ownKeys() auf target.

Beispiele

Abfangen von getOwnPropertyNames

Der folgende Code fängt Object.getOwnPropertyNames() ab.

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

console.log(Object.getOwnPropertyNames(p));
// "called"
// [ 'a', 'b', 'c' ]

Der folgende Code verletzt eine Invariante.

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

const p = new Proxy(obj, {
  ownKeys(target) {
    return [123, 12.5, true, false, undefined, null, {}, []];
  },
});

console.log(Object.getOwnPropertyNames(p));

// TypeError: proxy [[OwnPropertyKeys]] must return an array
// with only string and symbol elements

Spezifikationen

Specification
ECMAScript® 2026 Language Specification # sec-proxy-object-internal-methods-and-internal-slots-ownpropertykeys