Skip to content

docs: correct createBrowserHistory JSDoc option to parseLocation #7655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dfedoryshchev wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −1
Open

docs: correct createBrowserHistory JSDoc option to parseLocation #7655

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/history/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ function assignKeyAndIndex(index: number, state: HistoryState | undefined) {
* but if you need to ensure that the browser state is up to date, you can use the
* `history.flush` method to immediately flush all pending state changes to the browser URL.
* @param opts
* @param opts.getHref A function that returns the current href (path + search + hash)
* @param opts.parseLocation A function that returns the current location as a `HistoryLocation`
* @param opts.createHref A function that takes a path and returns a href (path + search + hash)
* @returns A history instance
*/
Expand Down