NavigationDestination: getState() method

{{APIRef("Navigation API")}}

The getState() method of the {{domxref("NavigationDestination")}} interface returns a clone of the developer-supplied state associated with the destination {{domxref("NavigationHistoryEntry")}}, or navigation operation (e.g., {{domxref("Navigation.navigate()", "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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Modern client-side routing: the Navigation API
• Navigation API explainer
• Methods that allow state to be updated — {{domxref("Navigation.navigate()")}}, {{domxref("Navigation.reload()")}}, and {{domxref("Navigation.updateCurrentEntry()")}}