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

var 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.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome Full support YesEdge No support NoFirefox Full support 53Opera Full support YesFirefox Android Full support 56

Legend

Full support  
Full support
No support  
No support

Examples

Remove cookies created in the last week:

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

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

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

var 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 simply want to clear all cookies without disrupting local storage facilities, use browser.cookies to loop through and remove the contents of all cookie stores.

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

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

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

Acknowledgements

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

Contributors to this page: wbamberg, Happy-Ferret, andrewtruongmoz
Last updated by: wbamberg,