NavigationHistoryEntry: getState() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The getState()
method of the
NavigationHistoryEntry
interface returns a clone of the developer-supplied state associated with this history entry.
Syntax
js
getState()
Parameters
None.
Return value
A value representing the state. This can be any structured-cloneable data type.
If no state is defined, it returns undefined
.
Exceptions
None.
Examples
js
async function handleReload() {
// Update existing state via reload()
await navigation.reload({
state: { ...navigation.currentEntry.getState(), newState: 3 },
});
// Print current state to the console
const current = navigation.currentEntry;
console.log(current.getState());
}
Specifications
Specification |
---|
Unknown specification # dom-navigationhistoryentry-getstate |
Browser compatibility
BCD tables only load in the browser
See also
- Modern client-side routing: the Navigation API
- Navigation API explainer
- Domenic Denicola's Navigation API live demo
- Methods that allow state to be updated —
Navigation.navigate()
,Navigation.reload()
, andNavigation.updateCurrentEntry()