Skip to content

Commit

Permalink
Fix parameter syntax for Navigation.updateCurrentEntry() (mdn#36852)
Browse files Browse the repository at this point in the history
* Fix parameter syntax for `Navigation.updateCurrentEntry()`

* Update index.md
  • Loading branch information
skyclouds2001 authored Nov 19, 2024
1 parent 6368e2b commit b55f5ca
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions files/en-us/web/api/navigation/updatecurrententry/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,12 @@ The **`updateCurrentEntry()`** method of the {{domxref("Navigation")}} interface
## Syntax

```js-nolint
updateCurrentEntry()
updateCurrentEntry(options)
```

### Parameters

- `options` {{optional_inline}}
- `options`
- : An options object containing the following properties:
- `state`
- : Developer-defined information to be stored in the associated {{domxref("NavigationHistoryEntry")}} once the navigation is complete, retrievable via {{domxref("NavigationHistoryEntry.getState", "getState()")}}. This can be any data type. You might, for example, wish to store a page visit count for analytics purposes, or store UI state details so the view can be shown exactly as the user last left it. Any data stored in `state` must be [structured-cloneable](/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm).
Expand Down

0 comments on commit b55f5ca

Please sign in to comment.