handler.preventExtensions()

The handler.preventExtensions() method is a trap for Object.preventExtensions().

Syntax

const p = new Proxy(target, {
  preventExtensions: function(target) {
  }
});

Parameters

The following parameter is passed to the preventExtensions() method. this is bound to the handler.

target

The target object.

Return value

The preventExtensions() method must return a boolean value.

Description

The handler.preventExtensions() method is a trap for Object.preventExtensions().

Interceptions

This trap can intercept these operations:

Invariants

If the following invariants are violated, the proxy will throw a TypeError:

  • Object.preventExtensions(proxy) only returns true if Object.isExtensible(proxy) is false.

Examples

Trapping of preventExtensions

The following code traps Object.preventExtensions().

const p = new Proxy({}, {
  preventExtensions: function(target) {
    console.log('called');
    Object.preventExtensions(target);
    return true;
  }
});

console.log(Object.preventExtensions(p)); // "called"
                                          // false

The following code violates the invariant.

const p = new Proxy({}, {
  preventExtensions: function(target) {
    return true;
  }
});

Object.preventExtensions(p); // TypeError is thrown

Specifications

Specification
ECMAScript Language Specification (ECMAScript)
# sec-proxy-object-internal-methods-and-internal-slots-preventextensions

Browser compatibility

BCD tables only load in the browser

See also