From f1079cbadd05453b220760cf521fbcf7d2fe1b93 Mon Sep 17 00:00:00 2001 From: Evan Sutherland Date: Sun, 22 Sep 2024 21:43:33 -0500 Subject: [PATCH] basic doc updates --- docs/api/types/ResolvedRoute.md | 8 ++++++++ docs/api/types/RouterPush.md | 1 + docs/api/types/RouterReplace.md | 1 + docs/api/types/RouterResolve.md | 1 + 4 files changed, 11 insertions(+) diff --git a/docs/api/types/ResolvedRoute.md b/docs/api/types/ResolvedRoute.md index eb618d6b..9dffe327 100644 --- a/docs/api/types/ResolvedRoute.md +++ b/docs/api/types/ResolvedRoute.md @@ -43,6 +43,14 @@ query: ResolvedRouteQuery; Accessor for query string values from user in the current browser location. [ResolvedRouteQuery](/api/types/ResolvedRouteQuery) +### hash + +```ts +hash?: string; +``` + +Accessor for hash string value (or undefined) from user in the current browser location. + ### params ```ts diff --git a/docs/api/types/RouterPush.md b/docs/api/types/RouterPush.md index 4352bb2b..4d6317ac 100644 --- a/docs/api/types/RouterPush.md +++ b/docs/api/types/RouterPush.md @@ -21,6 +21,7 @@ Push will update the URL for the browser and also add the URL into the history s { query?: Record, replace?: boolean, + hash?: string, } ``` diff --git a/docs/api/types/RouterReplace.md b/docs/api/types/RouterReplace.md index 674b9a43..8d2558b0 100644 --- a/docs/api/types/RouterReplace.md +++ b/docs/api/types/RouterReplace.md @@ -20,6 +20,7 @@ Replace has the same effect as [`RouterPush`](/api/types/RouterPush) but without ```ts { query?: Record, + hash?: string, } ``` diff --git a/docs/api/types/RouterResolve.md b/docs/api/types/RouterResolve.md index df1e68a1..1f427814 100644 --- a/docs/api/types/RouterResolve.md +++ b/docs/api/types/RouterResolve.md @@ -34,6 +34,7 @@ If source is `Url`, expected type for params is `never`. Else when source is `TS ```ts { query?: Record, + hash?: string, } ```