browsingData

This translation is incomplete. Please help translate this article from English

Enables extensions to clear the data that is accumulated while the user is browsing.

In the browsingData API, browsing data is divided into types:

  • browser cache
  • cookies
  • downloads
  • history
  • local storage
  • plugin data
  • saved form data
  • saved passwords

You can use the browsingData.remove() function to remove any combination of these types. There are also dedicated functions to remove each particular type of data, such as removePasswords(), removeHistory() and so on.

All the browsingData.remove[X]() functions take a browsingData.RemovalOptions object, which you can use to control two further aspects of data removal:

  • how far back in time to remove data
  • whether to remove data only from normal web pages, or also from hosted web apps and add-ons. Note that this option is not yet supported in Firefox.

Finally, this API gives you a browsingData.settings() function that gives you the current value of the settings for the browser's built-in "Clear History" feature.

To use this API you must have the "browsingData" API permission.

Types

browsingData.DataTypeSet
Object used to specify the type of data to remove: for example, history, downloads, passwords, and so on.
browsingData.RemovalOptions
Object used to specify how far back in time to remove data, and whether to remove data added through normal web browsing, by hosted apps, or by add-ons.

Methods

browsingData.remove()
Removes browsing data for the data types specified.
browsingData.removeCache()
Clears the browser's cache.
browsingData.removeCookies()
Removes cookies.
browsingData.removeDownloads()
Removes the list of downloaded files.
browsingData.removeFormData()
Clears saved form data.
browsingData.removeHistory()
Clears the browser's history.
browsingData.removeLocalStorage()
Clears any local storage created by websites.
browsingData.removePasswords()
Clears saved passwords.
browsingData.removePluginData()
Clears data associated with plugins.
browsingData.settings()
Gets the current value of settings in the browser's "Clear History" feature.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaSafariFirefox for Android
DataTypeSet.cacheChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support 56 — 79
DataTypeSet.cookiesChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support 56 — 79
DataTypeSet.downloadsChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support 56 — 79
DataTypeSet.fileSystemsChrome Full support YesEdge Full support 79Firefox No support NoOpera Full support YesSafari No support NoFirefox Android No support No
DataTypeSet.formDataChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support 56 — 79
DataTypeSet.historyChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari Full support 14Firefox Android No support 56 — 79
DataTypeSet.indexedDBChrome Full support YesEdge Full support 79Firefox Full support 57Opera Full support YesSafari No support NoFirefox Android No support No
DataTypeSet.localStorageChrome Full support YesEdge Full support 79Firefox Full support 57Opera Full support YesSafari No support NoFirefox Android No support No
DataTypeSet.passwordsChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support No
DataTypeSet.pluginDataChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support No
DataTypeSet.serverBoundCertificatesChrome Full support YesEdge Full support 79Firefox No support NoOpera Full support YesSafari No support NoFirefox Android No support No
DataTypeSet.serviceWorkersChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support No
RemovalOptions.hostnamesChrome No support NoEdge No support NoFirefox Full support 56Opera No support NoSafari No support NoFirefox Android No support No
RemovalOptions.originTypesChrome Full support YesEdge Full support 79Firefox No support NoOpera Full support YesSafari No support NoFirefox Android No support No
RemovalOptions.sinceChrome Full support YesEdge Full support 79Firefox Full support 53
Notes
Full support 53
Notes
Notes since is not supported with the following data types: cache, indexedDB, localStorage, and serviceWorkers.
Opera Full support YesSafari No support NoFirefox Android No support 56 — 79
Notes
No support 56 — 79
Notes
Notes since is not supported with the following data types: cache, indexedDB, localStorage, and serviceWorkers.
removeChrome Full support YesEdge Full support 79Firefox Full support 53
Notes
Full support 53
Notes
Notes Specifying dataTypes.history will also remove download history and service workers.
Opera Full support YesSafari No support NoFirefox Android No support 57 — 79
Notes
No support 57 — 79
Notes
Notes Specifying dataTypes.history will also remove download history and service workers.
removeCacheChrome Full support YesEdge Full support 79Firefox Full support 53
Notes
Full support 53
Notes
Notes removalOptions.since is not supported.
Opera Full support YesSafari No support NoFirefox Android No support 57 — 79
Notes
No support 57 — 79
Notes
Notes removalOptions.since is not supported.
removeCookiesChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support 56 — 79
removeDownloadsChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support 57 — 79
removeFormDataChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support 57 — 79
removeHistoryChrome Full support YesEdge Full support 79Firefox Full support 53
Notes
Full support 53
Notes
Notes This function also removes download history and service workers.
Opera Full support YesSafari No support NoFirefox Android No support No
Notes
No support No
Notes
Notes See bug 1363010. Before Firefox for Android 79, browser.history.remove(options, {history:true}) can be used instead.
removeLocalStorageChrome Full support YesEdge Full support 79Firefox Full support 57
Notes
Full support 57
Notes
Notes removalOptions.since is not supported.
Opera Full support YesSafari No support NoFirefox Android No support No
removePasswordsChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support No
removePluginDataChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support No
settingsChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support YesSafari No support NoFirefox Android No support 56 — 79

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

Example extensions

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.