CKTIS / JavaScript
Object.getOwnPropertySymbols — eigene Symbol-Schlüssel
Object.getOwnPropertySymbols(obj) gibt ein Array mit Symbol-Schlüsseln zurück. Bei gewöhnlichen Objekten sind das die Schlüssel eigener Eigenschaften, auch nicht aufzählbarer. Die Methode lässt Zeichenfolgen-Schlüssel aus und durchsucht die Prototypenkette nicht.
Version: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntax
Object.getOwnPropertySymbols(obj)Object.getOwnPropertySymbols(obj) ist eine statische Methode von Object, die ein neues Array erstellt. Es enthält nur die Symbol-Schlüssel aus der Liste, die die interne Operation [[OwnPropertyKeys]] des Objekts zurückgibt. Die Methode gibt Schlüssel zurück, nicht Werte oder Symbolbeschreibungen. Den Wert einer Eigenschaft liest du mit obj[key] aus.
Die Methode lässt Zeichenfolgen-Schlüssel aus und durchsucht die Prototypenkette nicht. Sie prüft keine Eigenschaftsdeskriptoren: Ein Proxy mit einem erweiterbaren Zielobjekt kann über seinen ownKeys-Trap ein Symbol melden, für das der Proxy keinen Deskriptor einer eigenen Eigenschaft hat.
Bei gewöhnlichen Objekten enthält das Ergebnis die Schlüssel sowohl aufzählbarer als auch nicht aufzählbarer eigener Eigenschaften. Die Symbole erscheinen in der Reihenfolge, in der diese Eigenschaften erstellt wurden. Object.keys(obj) gibt nur aufzählbare eigene Zeichenfolgen-Schlüssel zurück, Object.getOwnPropertyNames(obj) alle eigenen Zeichenfolgen-Schlüssel und Reflect.ownKeys(obj) beide Arten eigener Schlüssel.
Das Argument wird in ein Objekt umgewandelt; null und undefined führen zu einem TypeError. Symbole bieten keine Privatsphäre: Mit dieser Methode lassen sich solche Schlüssel auch dann finden, wenn enumerable: false gilt.
Im Beispiel enthält das Ergebnis visible und hidden, aber weder inherited noch name. Die Vergleiche prüfen die Identität der Symbole, und die letzte Zeile liest die Werte der entsprechenden Eigenschaften aus.
Beispiele
const inherited = Symbol('inherited');
const visible = Symbol('visible');
const hidden = Symbol('hidden');
const obj = Object.create({ [inherited]: 10 });
obj.name = 'demo';
obj[visible] = 20;
Object.defineProperty(obj, hidden, {
value: 30,
enumerable: false
});
const keys = Object.getOwnPropertySymbols(obj);
console.log(keys.length);
console.log(keys[0] === visible, keys[1] === hidden);
console.log(keys.includes(inherited));
console.log(keys.map(key => obj[key]).join(','));Ergebnis
2 true true false 20,30
Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.