Proxy.revocable()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since December 2017.

Die statische Methode Proxy.revocable() erstellt ein widerrufbares Proxy-Objekt.

Syntax

Proxy.revocable(target, handler)

Parameter

target: Ein Zielobjekt, das mit Proxy umschlossen wird. Es kann sich um jede Art von Objekt handeln, einschließlich eines nativen Arrays, einer Funktion, oder sogar eines weiteren Proxys.
handler: Ein Objekt, dessen Eigenschaften Funktionen sind, die das Verhalten des proxy definieren, wenn eine Operation darauf ausgeführt wird.

Rückgabewert

Ein einfaches Objekt mit den folgenden zwei Eigenschaften:

proxy: Ein Proxy-Objekt, das genau dem entspricht, welches mit einem new Proxy(target, handler)-Aufruf erstellt wurde.
revoke: Eine Funktion ohne Parameter, um den proxy zu widerrufen (deaktivieren).

Die Proxy.revocable()-Fabrikfunktion ist die gleiche wie der Proxy()-Konstruktor, außer dass sie zusätzlich zur Erstellung eines Proxy-Objekts auch eine revoke-Funktion erstellt, die aufgerufen werden kann, um den Proxy zu deaktivieren. Das Proxy-Objekt und die revoke-Funktion sind in einem einfachen Objekt eingebettet.

Die revoke-Funktion nimmt keine Parameter entgegen und hängt auch nicht vom Wert this ab. Das erstellte proxy-Objekt wird der revoke-Funktion als privates Feld angehängt, auf das die revoke-Funktion bei ihrem Aufruf zugreift (das Vorhandensein des privaten Feldes ist von außen nicht beobachtbar, hat jedoch Auswirkungen darauf, wie die Speicherbereinigung geschieht). Das proxy-Objekt wird nicht innerhalb der Schließung der revoke-Funktion erfasst (was die Speicherbereinigung von proxy unmöglich machen würde, wenn revoke noch existiert).

Nachdem die revoke()-Funktion aufgerufen wird, wird der Proxy unbrauchbar: Jede Falle für einen Handler wirft einen TypeError. Sobald ein Proxy widerrufen wurde, bleibt er widerrufen, und ein erneuter Aufruf von revoke() hat keine Wirkung — tatsächlich trennt der Aufruf von revoke() das proxy-Objekt von der revoke-Funktion, sodass die revoke-Funktion nicht mehr auf den Proxy zugreifen kann. Wenn der Proxy nicht anderweitig referenziert wird, wird er dann der Speicherbereinigung zugänglich. Die revoke-Funktion trennt auch target und handler vom proxy, sodass, wenn target nicht anderweitig referenziert wird, es auch der Speicherbereinigung zugänglich wird, selbst wenn sein Proxy noch existiert, da es keine Möglichkeit mehr gibt, mit dem Zielobjekt sinnvoll zu interagieren.

Wenn Benutzer mit einem Objekt über einen widerrufbaren Proxy interagieren, können Sie die Lebensdauer kontrollieren des dem Benutzer zugänglichen Objekts — Sie können das Objekt speicherbereinigbar machen, selbst wenn der Benutzer noch eine Referenz auf dessen Proxy hält.

Beispiele

Verwendung von Proxy.revocable()

const revocable = Proxy.revocable(
  {},
  {
    get(target, name) {
      return `[[${name}]]`;
    },
  },
);
const proxy = revocable.proxy;
console.log(proxy.foo); // "[[foo]]"

revocable.revoke();

console.log(proxy.foo); // TypeError is thrown
proxy.foo = 1; // TypeError again
delete proxy.foo; // still TypeError
typeof proxy; // "object", typeof doesn't trigger any trap

Spezifikationen

Specification
ECMAScript® 2026 Language Specification # sec-proxy.revocable

Browser-Kompatibilität

Siehe auch

Proxy