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 Methode handler.ownKeys()
ist eine Trap für die [[OwnPropertyKeys]]
interne Objektmethode, 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 der 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, ohne doppelte Einträge.
Beschreibung
Abfangmöglichkeiten
Diese Trap kann folgende Operationen abfangen:
Oder jede andere Operation, die die interne Methode [[OwnPropertyKeys]]
aufruft.
Invarianten
Die interne Methode [[OwnPropertyKeys]]
des Proxy löst einen TypeError
aus, wenn die Definition des Handlers 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 einSymbol
. - 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, muss der Schlüssel in der Ergebnisliste enthalten sein, wenn dieser Schlüssel durchReflect.getOwnPropertyDescriptor()
alsconfigurable: false
gemeldet wird. - Wenn das Zielobjekt nicht erweiterbar ist, muss die Ergebnisliste alle Schlüssel der eigenen Eigenschaften des Zielobjekts enthalten und keine anderen Werte. Das heißt, wenn
Reflect.isExtensible()
auftarget
false
zurückgibt, muss die Ergebnisliste dieselben Werte enthalten wie das Ergebnis vonReflect.ownKeys()
auftarget
.
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® 2025 Language Specification # sec-proxy-object-internal-methods-and-internal-slots-ownpropertykeys |
Browser-Kompatibilität
Report problems with this compatibility data on GitHubdesktop | mobile | server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ownKeys |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- See implementation notes.