handler.defineProperty()

Probieren Sie es aus

const handler = {
  defineProperty(target, key, descriptor) {
    invariant(key, "define");
    return true;
  },
};

function invariant(key, action) {
  if (key[0] === "_") {
    throw new Error(`Invalid attempt to ${action} private "${key}" property`);
  }
}

const monster = {};
const proxy = new Proxy(monster, handler);

console.log((proxy._secret = "easily scared"));
// Expected output: Error: Invalid attempt to define private "_secret" property

Syntax

new Proxy(target, {
  defineProperty(target, property, descriptor) {
  }
})

Parameter

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

target

Das Zielobjekt.

property

Ein String oder Symbol, der den Eigenschaftsnamen repräsentiert.

descriptor

Der Deskriptor für die zu definierende oder zu ändernde Eigenschaft.

Rückgabewert

Die defineProperty() Methode muss ein Boolean zurückgeben, das angibt, ob die Eigenschaft erfolgreich definiert wurde oder nicht. Andere Werte werden in Booleans umgewandelt.

Viele Operationen, einschließlich Object.defineProperty() und Object.defineProperties(), werfen einen TypeError, wenn die [[DefineOwnProperty]] interne Methode false zurückgibt.

Beschreibung

Abfangmöglichkeiten

Diese Trap kann folgende Operationen abfangen:

• Object.defineProperty(), Object.defineProperties()
• Reflect.defineProperty()

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

Invarianten

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

• Eine Eigenschaft kann nicht hinzugefügt werden, wenn das Zielobjekt nicht erweiterbar ist. Das heißt, wenn Reflect.isExtensible() false für target zurückgibt und Reflect.getOwnPropertyDescriptor() undefined für die Eigenschaft auf target zurückgibt, dann muss die Trap einen falschen Wert zurückgeben.
• Eine Eigenschaft kann nicht nicht-konfigurierbar sein, es sei denn, es gibt eine entsprechende nicht-konfigurierbare eigene Eigenschaft des Zielobjekts. Das heißt, wenn Reflect.getOwnPropertyDescriptor() undefined oder configurable: true für die Eigenschaft auf target zurückgibt, und descriptor.configurable ist false, dann muss die Trap einen falschen Wert zurückgeben.
• Eine nicht-konfigurierbare Eigenschaft kann nicht nicht-schreibbar sein, es sei denn, es gibt eine entsprechende nicht-konfigurierbare, nicht-schreibbare eigene Eigenschaft des Zielobjekts. Das heißt, wenn Reflect.getOwnPropertyDescriptor() configurable: false, writable: true für die Eigenschaft auf target zurückgibt und descriptor.writable ist false, dann muss die Trap einen falschen Wert zurückgeben.
• Wenn eine Eigenschaft eine entsprechende Eigenschaft auf dem Zielobjekt hat, dann muss der Deskriptor der Zieleigenschaft mit descriptor kompatibel sein. Das heißt, wenn man annimmt, target ist ein gewöhnliches Objekt, und Object.defineProperty(target, property, descriptor) würde einen Fehler werfen, dann muss die Trap einen falschen Wert zurückgeben. Die Object.defineProperty() Referenz enthält mehr Informationen, aber zusammengefasst, wenn die Zieleigenschaft nicht-konfigurierbar ist, muss Folgendes gelten:
  • configurable, enumerable, get und set können nicht geändert werden
  • die Eigenschaft kann nicht zwischen Daten- und Zugriffsorakel gewechselt werden
  • das writable Attribut kann nur von true zu false geändert werden
  • das value Attribut kann nur geändert werden, wenn writable true ist

Beispiele

Abfangen von defineProperty

Der folgende Code fängt Object.defineProperty() ab.

const p = new Proxy(
  {},
  {
    defineProperty(target, prop, descriptor) {
      console.log(`called: ${prop}`);
      return true;
    },
  },
);

const desc = { configurable: true, enumerable: true, value: 10 };
Object.defineProperty(p, "a", desc); // "called: a"

Beim Aufruf von Object.defineProperty() oder Reflect.defineProperty(), hat der descriptor, der an die defineProperty() Trap übergeben wird, eine Einschränkung — nur die folgenden Eigenschaften sind verwendbar (nicht-standardisierte Eigenschaften werden ignoriert):

• enumerable
• configurable
• writable
• value
• get
• set

const p = new Proxy(
  {},
  {
    defineProperty(target, prop, descriptor) {
      console.log(descriptor);
      return Reflect.defineProperty(target, prop, descriptor);
    },
  },
);

Object.defineProperty(p, "name", {
  value: "proxy",
  type: "custom",
}); // { value: 'proxy' }

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Proxy
• Proxy() Konstruktor
• Object.defineProperty()
• Reflect.defineProperty()