API Documentation • Docs

---

API Documentation / RouteLocationAsRelativeGeneric

Interface: RouteLocationAsRelativeGeneric

Generic version of RouteLocationAsRelative. It is used when no RouteMap is provided.

Extends

• RouteQueryAndHash.RouteLocationOptions

Extended by

• 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

RouteLocationOptions.force

---

hash?

optional hash: string

Inherited from

RouteQueryAndHash.hash

---

name?

optional name: RouteRecordNameGeneric

---

params?

optional params: RouteParamsRawGeneric

---

path?

optional path: undefined

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

---

query?

optional query: LocationQueryRaw

Inherited from

RouteQueryAndHash.query

---

replace?

optional replace: boolean

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

Inherited from

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

RouteLocationOptions.state