API Documentation / RouteLocationAsRelativeTyped

Interface: RouteLocationAsRelativeTyped<RouteMap, Name>

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

Type parameters

Name	Type
RouteMap	extends RouteMapGeneric = RouteMapGeneric
Name	extends keyof RouteMap = keyof RouteMap

Hierarchy

• RouteLocationAsRelativeGeneric

  ↳ RouteLocationAsRelativeTyped

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