cookies.onChanged

Syntax

browser.cookies.onChanged.addListener(listener)
browser.cookies.onChanged.removeListener(listener)
browser.cookies.onChanged.hasListener(listener)

This API is also available as browser.cookies.onChanged.*.

Events have three functions:

addListener(listener)

Adds a listener to this event.

removeListener(listener)

Stops listening to this event. The listener argument is the listener to remove.

hasListener(listener)

Checks whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

listener

The function called when this event occurs. The function is passed these arguments:

changeInfo

An object containing details of the change that occurred. Its properties are:

removed

A boolean set to true if a cookie was removed and false if not.

cookie

A cookies.Cookie object containing information about the cookie that was set or removed.

cause

A cookies.OnChangedCause value representing the underlying reason behind the cookie's change.

Examples

This example listens for onChanged events and logs details from the changeInfo argument:

browser.cookies.onChanged.addListener((changeInfo) => {
  console.log(
    `Cookie changed: \n` +
      ` * Cookie: ${JSON.stringify(changeInfo.cookie)}\n` +
      ` * Cause: ${changeInfo.cause}\n` +
      ` * Removed: ${changeInfo.removed}`,
  );
});

Example extensions

• cookie-bg-picker

Browser compatibility