history.deleteUrl()
Removes all visits to the given URL from the browser history.
This is an asynchronous function that returns aPromise
.
Syntax
js
let deletingUrl = browser.history.deleteUrl( details // object)
Parameters
Return value
APromise
will be fulfilled with no parameters when the visits have been removed.
Examples
Remove all visits to "https://example.org/" from history, then check that this URL no longer returned fromhistory.search()
:
js
let urlToRemove = "https://example.org/";function onGot(results) { if (!results.length) { console.log(`${urlToRemove} was removed`); } else { console.log(`${urlToRemove} was not removed`); }}function onRemoved() { let searching = browser.history.search({ text: urlToRemove, startTime: 0, }); searching.then(onGot);}let deletingUrl = browser.history.deleteUrl({ url: urlToRemove });deletingUrl.then(onRemoved);
Remove the last-visited page from history, with a listener tohistory.onVisitRemoved
to log the URL of the removed page:
js
function onRemoved(removeInfo) { if (removeInfo.urls.length) { console.log(`Removed: ${removeInfo.urls[0]}`); }}browser.history.onVisitRemoved.addListener(onRemoved);function onGot(results) { if (results.length) { console.log(`Removing: ${results[0].url}`); browser.history.deleteUrl({ url: results[0].url }); }}let searching = browser.history.search({ text: "", startTime: 0, maxResults: 1,});searching.then(onGot);
Example extensions
Browser compatibility
Note:This API is based on Chromium'schrome.history
API. This documentation is derived fromhistory.json
in the Chromium code.