handler.ownKeys()

Baseline Weitgehend verfügbar

Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit September 2016 browserübergreifend verfügbar.

Die handler.ownKeys()-Methode ist ein Trap für die [[OwnPropertyKeys]] interne Methode des Objekts, die von Operationen wie Object.keys(), Reflect.ownKeys() usw. verwendet wird.

In diesem Artikel

Probieren Sie es aus

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

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

const proxy = new Proxy(monster, handler);

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

Syntax

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

Parameter

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

target

Das Zielobjekt.

Rückgabewert

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

Beschreibung

Interceptions

Dieser Trap kann diese Operationen abfangen:

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

Invarianten

Die [[OwnPropertyKeys]]-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 durch Reflect.ownKeys() auf dem Zielobjekt zurückgegeben werden, muss der Schlüssel enthalten sein, wenn der Schlüssel durch Reflect.getOwnPropertyDescriptor() configurable: false meldet.
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 die gleichen Werte wie das Ergebnis von Reflect.ownKeys() auf target enthalten.

Beispiele

Abfangen von getOwnPropertyNames

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

js
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.

js
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

Spezifikation

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

Browser-Kompatibilität

JavaScript aktivieren, um diese Browser-Kompatibilitätstabelle anzuzeigen.

Siehe auch

Help improve MDN

War diese Übersetzung hilfreich?

Ja Nein

Erfahren Sie, wie Sie beitragen können Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden

Eingebaute Standardobjekte
Proxy/handler
Instanzmethoden
Vererbung
Object/Function
Statische Methoden
Statische Eigenschaften
Instanzmethoden
Instanzeigenschaften
1. __proto__
2. constructor
Verwandte Seiten
Proxy