NavigationHistoryEntry: getState() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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 or if current document is not fully active, 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
HTML Standard
# dom-navigationhistoryentry-getstate-dev

Browser compatibility

BCD tables only load in the browser

See also