WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Object.defineProperty: präziser Eigenschaftsdeskriptor

Object.defineProperty definiert oder ändert eine eigene Eigenschaft mit einem expliziten Daten- oder Accessordeskriptor.

Version: ECMAScript 5 onward; example target: Node.js 24.22.2

Syntax

Object.defineProperty(obj, key, descriptor)

Object.defineProperty(obj, key, descriptor) verlangt ein tatsächliches Objekt als obj; primitive Werte werden nicht verpackt. key durchläuft ToPropertyKey und wird somit String oder Symbol. descriptor wird durch ToPropertyDescriptor gelesen, und die Methode gibt dasselbe Zielobjekt zurück.

Ein Datendeskriptor nutzt value und writable, ein Accessordeskriptor get und set; Felder beider Arten zu kombinieren wirft TypeError. Beim Erstellen einer neuen Eigenschaft werden fehlende writable, enumerable und configurable zu false, fehlende value, get und set bedeuten undefined; beim Ändern einer bestehenden Eigenschaft lassen ausgelassene Felder deren aktuelle Attribute unverändert. Getter und Setter müssen aufrufbar oder undefined sein.

Die Methode existiert seit ECMAScript 5. DefinePropertyOrThrow wirft TypeError, wenn eine neue Eigenschaft zu einem nicht erweiterbaren Objekt hinzugefügt wird, eine Änderung die Regeln einer nicht konfigurierbaren Eigenschaft verletzt oder ein Proxy Invarianten bricht. Eine kompatible Neudefinition einer bestehenden Eigenschaft kann auch an einem nicht erweiterbaren Objekt gelingen. Anders als eine Zuweisung steuert sie Attribute ohne geerbten Setter aufzurufen; Deskriptorfelder und Proxy-Fallen können dennoch Code ausführen und werfen.

Beispiele

const account = {};
const same = Object.defineProperty(account, "balance", {
  value: 10, writable: false, enumerable: true, configurable: false
});
let reads = 0;
Object.defineProperty(account, "label", {
  get() { return `#${++reads}`; }, configurable: true
});
console.log(same === account, Object.keys(account).join(","));
console.log(account.balance, account.label, account.label);
const balance = Object.getOwnPropertyDescriptor(account, "balance");
const label = Object.getOwnPropertyDescriptor(account, "label");
console.log(balance.writable, balance.configurable, label.set);
try { Object.defineProperty(account, "balance", { value: 11 }); }
catch (error) { console.log(error.name, account.balance); }
try { Object.defineProperty({}, "x", { value: 1, get() {} }); }
catch (error) { console.log(error.name); }

Ergebnis

true balance
10 #1 #2
false false undefined
TypeError 10
TypeError

Das Beispiel definiert Dateneigenschaft und Getter, prüft Attribute und zeigt zwei TypeError-Fälle.

Quellen