webNavigation.onHistoryStateUpdated
===================================

Fired when the page used the >history API to update the URL displayed in the browser's location bar. All future events for this frame will use the updated URL.

Syntax
------


```js
browser.webNavigation.onHistoryStateUpdated.addListener(
  listener,                   // function
  filter                      // optional object
)
browser.webNavigation.onHistoryStateUpdated.removeListener(listener)
browser.webNavigation.onHistoryStateUpdated.hasListener(listener)
```


Events have three functions:

`addListener(listener)`

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. Returns `true` if it is listening, `false` otherwise.

addListener syntax
------------------

### Parameters

`listener`

The function called when this event occurs. The function is passed this argument:

`details`

`object`. Details about the navigation event. See the details section for more information.


`filter` Optional

`object`. An object containing a single property `url`, which is an `Array` of `events.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.

Additional objects
------------------

### details

`tabId`

`integer`. The ID of the tab in which the navigation is about to occur.

`url`

`string`. The URL to which the given frame will navigate.

`processId` Optional 
Deprecated

`integer`. This value is not set in modern browsers. When it was set, it represented the ID of the process running the renderer for this tab.

`frameId`

`integer`. Frame in which the navigation will occur. `0` indicates that navigation happens in the tab's top-level browsing context, not in a nested `<iframe>`. A positive value indicates that navigation happens in a nested iframe. Frame IDs are unique for a given tab and process.

`timeStamp`

`number`. The time that the URL was changed by the history API, in milliseconds since the epoch.

`transitionType`

``transitionType``. The reason for the navigation: for example, `"link"` if the user clicked a link.

`transitionQualifiers`

`Array` of `transitionQualifier`. Extra information about the navigation: for example, whether there was a server or client redirect.

Browser compatibility
---------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Examples
--------

Logs the target URLs and extra transition information for `onHistoryStateUpdated`, if the target URL's hostname contains "example.com" or starts with "developer".


```js
const filter = {
  url: [{ hostContains: "example.com" }, { hostPrefix: "developer" }],
};

function logOnHistoryStateUpdated(details) {
  console.log(`onHistoryStateUpdated: ${details.url}`);
  console.log(`Transition type: ${details.transitionType}`);
  console.log(`Transition qualifiers: ${details.transitionQualifiers}`);
}

browser.webNavigation.onHistoryStateUpdated.addListener(
  logOnHistoryStateUpdated,
  filter,
);
```


**Note:** This API is based on Chromium's `chrome.webNavigation` API. This documentation is derived from `web_navigation.json` in the Chromium code.