API Documentation • Docs
API Documentation / RouteLocationAsRelativeTyped
Interface: RouteLocationAsRelativeTyped<RouteMap, Name> Helper to generate a type safe version of the RouteLocationAsRelative type.
Extends Type Parameters • RouteMap extends RouteMapGeneric
= RouteMapGeneric
• Name extends keyof RouteMap
= keyof RouteMap
optional
force:boolean
Triggers the navigation even if the location is the same as the current one. Note this will also add a new entry to the history unless replace: true
is passed.
RouteLocationAsRelativeGeneric
.force
Inherited from
optional
hash:string
RouteLocationAsRelativeGeneric
.hash
Overrides
optional
name:Extract
<Name
,string
|symbol
>
RouteLocationAsRelativeGeneric
.name
Overrides
optional
params:RouteMap
[Name
]["paramsRaw"
]
RouteLocationAsRelativeGeneric
.params
optional
path:undefined
A relative path to the current location. This property should be removed
Inherited from RouteLocationAsRelativeGeneric
.path
Inherited from
optional
query:LocationQueryRaw
RouteLocationAsRelativeGeneric
.query
optional
replace:boolean
Replace the entry in the history instead of pushing a new entry
Inherited from RouteLocationAsRelativeGeneric
.replace
optional
state:HistoryState
State to save using the History API. This cannot contain any reactive values and some primitives like Symbols are forbidden. More info at https://developer.mozilla.org/en-US/docs/Web/API/History/state
Inherited from RouteLocationAsRelativeGeneric
.state
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4