handler.ownKeys()

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

target

Das Zielobjekt.

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

Diese Trap kann folgende Operationen abfangen:

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

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

Die [[OwnPropertyKeys]] interne Methode des Proxys wirft einen TypeError, wenn die Handlerdefinition 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 bedeutet, für alle Schlüssel, die von Reflect.ownKeys() auf dem Zielobjekt zurückgegeben werden, wenn der Schlüssel durch Reflect.getOwnPropertyDescriptor() als konfigurierbar: 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 bedeutet, wenn Reflect.isExtensible() false auf target zurückgibt, muss die Ergebnisliste die gleichen Werte enthalten wie das Ergebnis von Reflect.ownKeys() auf target.

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

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