browsingData.removeCookies()

Clears the browser's cookies.

You can use the removalOptions parameter, which is a browsingData.RemovalOptions object, to:

  • clear only cookies created after a given time
  • control whether to clear cookies only set from normal web pages or to clear cookies set from hosted apps and extensions as well.

This is an asynchronous function that returns a Promise.

Syntax

js
let removing = browser.browsingData.removeCookies(
  removalOptions            // RemovalOptions object
)

Parameters

removalOptions

object. A browsingData.RemovalOptions object, which may be used to clear only cookies created after a given time, and whether to clear cookies only set from normal web pages or to clear cookies set from hosted apps and extensions as well.

Return value

A Promise that will be fulfilled with no arguments when the removal has finished. If any error occurs, the promise will be rejected with an error message.

Examples

Remove cookies created in the last week:

js
function onRemoved() {
  console.log("removed");
}

function onError(error) {
  console.error(error);
}

function weekInMilliseconds() {
  return 1000 * 60 * 60 * 24 * 7;
}

let oneWeekAgo = new Date().getTime() - weekInMilliseconds();

browser.browsingData
  .removeCookies({ since: oneWeekAgo })
  .then(onRemoved, onError);

Remove all cookies:

Warning: Using the API to remove all cookies will, simultaneously, clear all local storage objects (including those of other extensions).

If you want to clear all cookies without disrupting local storage facilities, use browser.cookies to loop through and remove the contents of all cookie stores.

js
function onRemoved() {
  console.log("removed");
}

function onError(error) {
  console.error(error);
}

browser.browsingData.removeCookies({}).then(onRemoved, onError);

Browser compatibility

BCD tables only load in the browser

Note: This API is based on Chromium's chrome.browsingData API.