webNavigation.onErrorOccurred
Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.
Syntax
browser.webNavigation.onErrorOccurred.addListener(
listener, // function
filter // optional object
)
browser.webNavigation.onErrorOccurred.removeListener(listener)
browser.webNavigation.onErrorOccurred.hasListener(listener)
Events have three functions:
addListener(listener)
addListener(listener, filter)
-
Adds a listener to this event.
removeListener(listener)
-
Stop listening to this event. The
listener
argument is the listener to remove. hasListener(listener)
-
Check whether
listener
is registered for this event. Returnstrue
if it is listening,false
otherwise.
addListener syntax
Parameters
listener
-
The function called when this event occurs.
The
listener
function is called with these arguments:details
-
object
. Details about the navigation event.details
has the following properties:tabId
-
integer
. The ID of the tab in which the navigation was happening. url
-
string
. The URL to which the given frame was navigating. processId
Optional Deprecated-
integer
. This value is never set in modern browsers. It used to represent the ID of the process running the renderer for this tab. frameId
-
integer
. Frame in which the navigation was happening.0
indicates that navigation happened in the tab's top-level browsing context, not in a nested<iframe>
.A positive value indicates that navigation happened in a nested iframe.
Frame IDs are unique for a given tab and process.
timeStamp
-
number
. The time at which the error occurred, in milliseconds since the epoch. error
-
string
. The error code. This is an internal error code, and is not guaranteed to stay the same or be consistent from one browser to another.
filter
Optional-
object
. An object containing a single propertyurl
, which is anArray
ofevents.UrlFilter
objects.If you include this parameter, then the event fires only for transitions to URLs which match at least one
UrlFilter
in the array.If you omit this parameter, the event fires for all transitions.
Browser compatibility
BCD tables only load in the browser
Examples
Logs the target URLs for onErrorOccurred
, if the target URL's hostname
contains "example.com"
or starts with "developer"
.
const filter = {
url: [{ hostContains: "example.com" }, { hostPrefix: "developer" }],
};
function logOnErrorOccurred(details) {
console.log(`onErrorOccurred: ${details.url}`);
console.log(details.error);
}
browser.webNavigation.onErrorOccurred.addListener(logOnErrorOccurred, filter);
Note:
This API is based on Chromium's chrome.webNavigation
API. This documentation is derived from web_navigation.json
in the Chromium code.