API Documentation / RouteLocationAsPathTyped

Interface: RouteLocationAsPathTyped<RouteMap, Name>

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

Type parameters

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

Hierarchy

• RouteLocationAsPathGeneric

  ↳ RouteLocationAsPathTyped

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

RouteLocationAsPathGeneric.force

---

hash

• Optional hash: string

Inherited from

RouteLocationAsPathGeneric.hash

---

path

• path: _LiteralUnion<RouteMap[Name]["path"]>

Percentage encoded pathname section of the URL.

Overrides

RouteLocationAsPathGeneric.path

---

query

• Optional query: LocationQueryRaw

Inherited from

RouteLocationAsPathGeneric.query

---

replace

• Optional replace: boolean

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

Inherited from

RouteLocationAsPathGeneric.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

RouteLocationAsPathGeneric.state