NavigationDestination.getState()

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The getState() method of the NavigationDestination interface returns a clone of the developer-supplied state associated with the destination NavigationHistoryEntry, or navigation operation (e.g. navigate()) as appropriate.

Syntax

getState()

Parameters

None.

Return value

A value representing the state. This can be any type.

If no state is defined, it returns undefined.

Exceptions

None.

Examples

navigation.addEventListener('navigate', (event) => {
  console.log(event.destination.getState());
});

Specifications

Specification
Navigation API
# dom-navigationdestination-getstate

Browser compatibility

BCD tables only load in the browser

See also