cookies.remove()

The remove() method of the cookies API deletes a cookie, given its name and URL.

The call succeeds only if you include the "cookies" API permission in your manifest.json file, as well as host permissions for the given URL specified in its manifest.

This is an asynchronous function that returns a Promise.

Syntax

var removing = browser.cookies.remove(
  details               // object
)

Parameters

details
An object containing information to identify the cookie to remove. It contains the following properties:
url
A string representing the URL associated with the cookie. If the add-on does not have host permissions for this URL, the API call will fail.
name
A string representing the name of the cookie to remove.
storeIdOptional
A string representing the ID of the cookie store to find the cookie in. If unspecified, the cookie is looked for by default in the current execution context's cookie store.

Return value

A Promise that will be fulfilled with a cookies.Cookie object containing details about the cookie that's been removed. If a cookie matching the details parameter could not be found, the promise is fulfilled with null.  If the call fails for any reason, the promise will be rejected with an error message.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 48.0 33

Examples

This example tries to remove the cookie named "favourite-colour", whose URL matches the URL of the document hosted by the currently active tab:

function onRemoved(cookie) {
  console.log(`Removed: ${cookie}`);
}

function onError(error) {
  console.log(`Error removing cookie: ${error}`);
}

function removeCookie(tabs) {
  var removing = browser.cookies.remove({
    url: tabs[0].url,
    name: "favourite-colour"
  });
  removing.then(onRemoved, onError);
}

var getActive = browser.tabs.query({active: true, currentWindow: true});
getActive.then(removeCookie);

Example add-ons

Acknowledgements

This API is based on Chromium's chrome.cookies API. This documentation is derived from cookies.json in the Chromium code.

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, Makyen, chrisdavidmills
 Last updated by: wbamberg,