history.deleteUrl()
Removes all visits to the given URL from the browser history.
This is an asynchronous function that returns a Promise
.
Syntax
var deletingUrl = browser.history.deleteUrl(
details // object
)
Parameters
Return value
A Promise
will be fulfilled with no parameters when the visits have been removed.
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
deleteUrl | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support49 | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
Legend
- Full support
- Full support
- No support
- No support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Examples
Remove all visits to "https://example.org/" from history, then check that this URL no longer returned from history.search()
:
var urlToRemove = "https://example.org/";
function onGot(results) {
if (!results.length) {
console.log(urlToRemove + " was removed");
} else {
console.log(urlToRemove + " was not removed");
}
}
function onRemoved() {
var searching = browser.history.search({
text: urlToRemove,
startTime: 0
});
searching.then(onGot);
}
var deletingUrl = browser.history.deleteUrl({url: urlToRemove});
deletingUrl.then(onRemoved);
Remove the last-visited page from history, with a listener to history.onVisitRemoved
to log the URL of the removed page:
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});
}
}
var searching = browser.history.search({
text: "",
startTime: 0,
maxResults: 1
});
searching.then(onGot);
Example extensions
Acknowledgements
This API is based on Chromium's chrome.history
API. This documentation is derived from history.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.