handler.set()

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 handler.set()-Methode ist ein Trap für die [[Set]] interne Objektmethode, die bei Operationen wie der Verwendung von Property-Zugriffen verwendet wird, um den Wert einer Eigenschaft festzulegen.

Probieren Sie es aus

const monster1 = { eyeCount: 4 };

const handler1 = {
  set(obj, prop, value) {
    if (prop === "eyeCount" && value % 2 !== 0) {
      console.log("Monsters must have an even number of eyes");
    } else {
      return Reflect.set(...arguments);
    }
  },
};

const proxy1 = new Proxy(monster1, handler1);

proxy1.eyeCount = 1;
// Expected output: "Monsters must have an even number of eyes"

console.log(proxy1.eyeCount);
// Expected output: 4

proxy1.eyeCount = 2;
console.log(proxy1.eyeCount);
// Expected output: 2

Syntax

new Proxy(target, {
  set(target, property, value, receiver) {
  }
})

Parameter

Die folgenden Parameter werden an die set()-Methode übergeben. this ist an den Handler gebunden.

target: Das Zielobjekt.
property: Ein String oder Symbol, der den Eigenschaftsnamen darstellt.
value: Der neue Wert der festzulegenden Eigenschaft.
receiver: Der this-Wert für Setter; siehe Reflect.set(). Dies ist normalerweise entweder der Proxy selbst oder ein Objekt, das vom Proxy erbt.

Rückgabewert

Die set()-Methode muss ein Boolean zurückgeben, das angibt, ob die Zuweisung erfolgreich war oder nicht. Andere Werte werden in Booleans umgewandelt.

Viele Operationen, einschließlich der Verwendung von Property-Zugriffen im strict mode, werfen einen TypeError, wenn die [[Set]]-Methode false zurückgibt.

Beschreibung

Abfangmöglichkeiten

Dieser Trap kann folgende Operationen abfangen:

Eigenschaftszuweisung: proxy[foo] = bar und proxy.foo = bar
Reflect.set()

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

Invarianten

Die [[Set]]-Methode des Proxys wirft einen TypeError, wenn die Handler-Definition eine der folgenden Invarianten verletzt:

Der Wert einer Eigenschaft kann nicht geändert werden, um sich von dem Wert der entsprechenden Zielobjekteigenschaft zu unterscheiden, wenn die entsprechende Zielobjekteigenschaft eine nicht beschreibbare, nicht konfigurierbare eigene Dateneigenschaft ist. Das heißt, wenn Reflect.getOwnPropertyDescriptor() configurable: false, writable: false für die Eigenschaft auf target zurückgibt und sich value von dem value-Attribut im Property-Descriptor des target unterscheidet, muss der Trap einen nicht-wahrheitsgemäßen Wert zurückgeben.
Der Wert einer Eigenschaft kann nicht gesetzt werden, wenn die entsprechende Zielobjekteigenschaft eine nicht konfigurierbare eigene Accessor-Eigenschaft ist, die einen undefinierten Setter hat. Das heißt, wenn Reflect.getOwnPropertyDescriptor() configurable: false, set: undefined für die Eigenschaft auf target zurückgibt, muss der Trap einen nicht-wahrheitsgemäßen Wert zurückgeben.

Beispiele

Trap beim Setzen eines Eigenschaftswerts

Der folgende Code fängt das Setzen eines Eigenschaftswerts ab.

const p = new Proxy(
  {},
  {
    set(target, prop, value, receiver) {
      target[prop] = value;
      console.log(`property set: ${prop} = ${value}`);
      return true;
    },
  },
);

console.log("a" in p); // false

p.a = 10; // "property set: a = 10"
console.log("a" in p); // true
console.log(p.a); // 10

Spezifikationen

Specification
ECMAScript® 2026 Language Specification # sec-proxy-object-internal-methods-and-internal-slots-set-p-v-receiver