The handler.deleteProperty()
method is a trap for the delete
operator.
The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.
Syntax
const 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 or
Symbol
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:
- Property deletion:
delete proxy[foo]
anddelete proxy.foo
Reflect.deleteProperty()
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
Trapping the delete operator
The following code traps the delete
operator.
const p = new Proxy({}, { deleteProperty: function(target, prop) { if (prop in target){ delete target[prop] console.log('property removed: ' + prop) return true } else { console.log('property not found: ' + prop) return false } } }) let result p.a = 10 console.log('a' in p) // true result = delete p.a // "property removed: a" console.log(result) // true console.log('a' in p) // false result = delete p.a // "property not found: a" console.log(result) // false
Specifications
Specification |
---|
ECMAScript (ECMA-262) The definition of '[[Delete]]' in that specification. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | Server | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
deleteProperty | Chrome Full support 49 | Edge Full support 12 | Firefox Full support 18 | IE No support No | Opera Full support 36 | Safari Full support 10 | WebView Android Full support 49 | Chrome Android Full support 49 | Firefox Android Full support 18 | Opera Android Full support 36 | Safari iOS Full support 10 | Samsung Internet Android Full support 5.0 | nodejs Full support 6.0.0 |
Legend
- Full support
- Full support
- No support
- No support
See also
Proxy
handler
delete
operatorReflect.deleteProperty()