history.onVisitRemoved
Fired when a page is removed completely from the browser history.
- If all visits to a single page are removed (for example, using
history.deleteUrl), then this event is fired once. - If a range of visits is removed (for example, using
history.deleteRangeor a browser feature like "Clear Recent History"), then it is fired once for each page whose visits all fall within the cleared range. - If the browser's entire history is cleared (for example, using
history.deleteAll), then it is fired only once.
Syntax
browser.history.onVisitRemoved.addListener(listener) browser.history.onVisitRemoved.removeListener(listener) browser.history.onVisitRemoved.hasListener(listener)
Events have three functions:
addListener(callback)-
Adds a listener to this event.
removeListener(listener)-
Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)-
Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
callback-
Function that will be called when this event occurs. The function will be passed the following argument:
removed-
object. Details of the removal. This is an object containing two properties: a booleanallHistoryand an arrayurls.- If this event is firing because all history was cleared,
allHistorywill betrueandurlswill be an empty array. - Otherwise,
allHistorywill befalseandurlswill contain one item, which is the URL of the removed page.
- If this event is firing because all history was cleared,
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
onVisitRemoved |
Yes | 79 | 50 | ? | Yes | No | ? | ? | No | ? | No | ? |
Examples
function onRemoved(removed) { if (removed.allHistory) { console.log("All history removed"); } else if (removed.urls.length) { console.log(`URL removed: ${removed.urls[0]}`); } } browser.history.onVisitRemoved.addListener(onRemoved);
Note: This API is based on Chromium's chrome.history API. This documentation is derived from history.json in the Chromium code.
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/history/onVisitRemoved