@locker/eslint-plugin-locker
Version:
Lightning Web Security ESLint rules
30 lines (17 loc) • 1.75 kB
Markdown
# Disallowed CookieStore Properties (distorted-cookie-store-blocked-properties)
For security the following `CookieStore` properties are disallowed by Lightning Web Security:
<!-- START generated embed: @locker/distortion/src/CookieStore/docs/addEventListener-value.md -->
## CookieStore.prototype.addEventListener
The [`CookieStore.prototype.addEventListener()`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener) method of the `EventTarget` interface sets up a function that will be called whenever the specified event is delivered to the target.
Common targets are `Element`, or its children, `Document`, and `Window`, but the target may be any object that supports events (such as `XMLHttpRequest`).
This distortion prevents code from accessing cookies outside of the sandbox.
### Distorted Behavior
Lightning Web Security does not support the `change` event of `CookieStore` objects. Calls to `CookieStore.prototype.addEventListener()` for the `change` event throw an exception.
<!-- END generated embed, please keep comment -->
<!-- START generated embed: @locker/distortion/src/CookieStore/docs/onchange-setter.md -->
## CookieStore.prototype.onchange setter
The [`CookieStore.prototype.onchange()`](https://developer.mozilla.org/en-US/docs/Web/API/CookieStore/onchange) event handler of the `CookieStore` interface fires when a change is made to any cookie.
This distortion prevents code from accessing cookies outside of the sandbox.
### Distorted Behavior
Currently, Lightning Web Security doesn't support the `CookieStore.onchange` event, so setting the `onchange` property, or adding a `change` event listener is not allowed and throws an exception.
<!-- END generated embed, please keep comment -->