API Documentation / RouteLocationAsRelativeGeneric

Interface: RouteLocationAsRelativeGeneric

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

Hierarchy

• RouteQueryAndHash

• RouteLocationOptions

  ↳ 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

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