CKTIS / JavaScript
Object.defineProperty: precyzyjny deskryptor właściwości
Object.defineProperty definiuje albo zmienia pojedynczą własną właściwość przy użyciu jawnego deskryptora danych lub akcesora.
Wersja: ECMAScript 5 onward; example target: Node.js 24.22.2
Składnia
Object.defineProperty(obj, key, descriptor)Object.defineProperty(obj, key, descriptor) wymaga rzeczywistego obiektu jako obj; wartości pierwotne nie są opakowywane. key przechodzi przez ToPropertyKey, więc może stać się tekstem albo symbolem. descriptor jest odczytywany przez ToPropertyDescriptor, a metoda zwraca ten sam obiekt celu.
Deskryptor danych używa value i writable, a deskryptor akcesora — get i set; połączenie pól obu rodzajów powoduje TypeError. Przy tworzeniu nowej właściwości brakujące writable, enumerable i configurable domyślnie są false, a brakujące value, get i set oznaczają undefined; przy zmianie istniejącej właściwości pominięte pola pozostawiają jej bieżące atrybuty bez zmian. Getter i setter muszą być funkcjami albo undefined.
Metoda istnieje od ECMAScript 5. DefinePropertyOrThrow rzuca TypeError, gdy próbuje dodać nową właściwość do nierozszerzalnego obiektu, gdy zmiana narusza reguły niekonfigurowalnej właściwości albo Proxy łamie niezmienniki. Zgodna redefinicja istniejącej właściwości może się powieść nawet na obiekcie nierozszerzalnym. W przeciwieństwie do przypisania metoda kontroluje atrybuty bez uruchamiania odziedziczonego settera, choć odczyt pól deskryptora i pułapki Proxy mogą wykonywać kod i rzucać.
Przykłady
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); }Wynik
true balance 10 #1 #2 false false undefined TypeError 10 TypeError
Przykład definiuje właściwość danych i getter, sprawdza atrybuty oraz dwa przypadki TypeError.