browsingData.removeHistory()

Clears the record of web pages that the user has visited (browsing history).

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

  • clear only records of web pages visited after a given time
  • control whether to clear only records of normal web pages or to clear records of hosted apps and add-ons as well.

This is an asynchronous function that returns a Promise.

Syntax

var removing = browser.browsingData.removeHistory(
  removalOptions            // RemovalOptions object
)

Parameters

removalOptions
object. A browsingData.RemovalOptions object, which may be used to clear only records of web pages visited after a given time, and whether to clear only records of normal web pages or to clear records of hosted apps and add-ons 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

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 53.0 No No

Compatibility notes

Firefox

  • 'removalOptions' does not support 'protectedWeb' or 'extension' as values of 'originTypes'.

Examples

Remove records of pages visited 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.removeHistory(
  {since: oneWeekAgo}).
then(onRemoved, onError);

Remove all records of visited pages:

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

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

browser.browsingData.removeHistory({}).
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
 Last updated by: wbamberg,