ContextQMD
Back to Content

NavigationHistoryEntry: getState() method

files/en-us/web/api/navigationhistoryentry/getstate/index.md

latest1.3 KB
Original Source

{{APIRef("Navigation API")}}

The getState() method of the {{domxref("NavigationHistoryEntry")}} interface returns a clone of the developer-supplied state associated with this history entry.

Syntax

js-nolint
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

{{Specifications}}

Browser compatibility

{{Compat}}

See also