handler.deleteProperty()

The handler.deleteProperty() method is a trap for the delete operator.

Syntax

var p = new Proxy(target, {
  deleteProperty: function(target, property) {
  }
});

Parameters

The following parameters are passed to the deleteProperty method. this is bound to the handler.

target
The target object.
property
The name of the property to delete.

Return value

The deleteProperty method must return a Boolean indicating whether or not the property has been successfully deleted.

Description

The handler.deleteProperty() method is a trap for the delete operator.

Interceptions

This trap can intercept these operations:

Invariants

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

  • A property cannot be deleted, if it exists as a non-configurable own property of the target object.

Examples

The following code traps the delete operator.

var p = new Proxy({}, {
  deleteProperty: function(target, prop) {
    console.log("called: " + prop);
    return true;
  }
});

delete p.a; // "called: a"

Specifications

Specification Status Comment
ECMAScript 2015 (6th Edition, ECMA-262)
The definition of '[[Delete]]' in that specification.
Standard Initial definition.
ECMAScript 2017 Draft (ECMA-262)
The definition of '[[Delete]]' in that specification.
Draft  

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support ? 18 (18) ? ? ?
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support ? ? 18.0 (18) ? ? ?

See also

Document Tags and Contributors

 Contributors to this page: eduardoboucas, fscholz, arai
 Last updated by: eduardoboucas,