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: -
firstPartyDomain
Optional- A
string
representing the first-party domain with which the cookie to remove is associated. This property must be supplied if the browser has first-party isolation enabled. See First-party isolation. name
- A
string
representing the name of the cookie to remove. storeId
Optional- 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. url
- A
string
representing the URL associated with the cookie. If the extension does not have host permissions for this URL, the API call will fail.
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
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
remove | ChromeFull supportYes | EdgeFull support14 | FirefoxFull support45
| OperaFull supportYes | SafariFull support14 | Firefox for AndroidFull support48
|
firstPartyDomain | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support59 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support59 |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
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 extensions
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.