API Documentation • Docs

---

API Documentation / RouteLocationAsRelativeTyped

Interface: RouteLocationAsRelativeTyped<RouteMap, Name>

Helper to generate a type safe version of the RouteLocationAsRelative type.

Extends

• RouteLocationAsRelativeGeneric

Type Parameters

• RouteMap extends RouteMapGeneric = RouteMapGeneric

• Name extends keyof RouteMap = keyof RouteMap

Properties

force?

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.

Inherited from

RouteLocationAsRelativeGeneric.force

---

hash?

optional hash: string

Inherited from

RouteLocationAsRelativeGeneric.hash

---

name?

optional name: Extract<Name, string | symbol>

Overrides

RouteLocationAsRelativeGeneric.name

---

params?

optional params: RouteMap[Name]["paramsRaw"]

Overrides

RouteLocationAsRelativeGeneric.params

---

path?

optional path: undefined

A relative path to the current location. This property should be removed

Inherited from

RouteLocationAsRelativeGeneric.path

---

query?

optional query: LocationQueryRaw

Inherited from

RouteLocationAsRelativeGeneric.query

---

replace?

optional replace: boolean

Replace the entry in the history instead of pushing a new entry

Inherited from

RouteLocationAsRelativeGeneric.replace

---

state?

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