@yesstudio/nuxt-composables
    Preparing search index...

    Interface RouteLocationAsRelativeTyped<RouteMap, Name>

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

    interface RouteLocationAsRelativeTyped<
        RouteMap extends RouteMapGeneric = RouteMapGeneric,
        Name extends keyof RouteMap = keyof RouteMap,
    > {
        force?: boolean;
        hash?: string;
        name?: Extract<Name, string | symbol>;
        params?: RouteMap[Name]["paramsRaw"];
        path?: undefined;
        query?: LocationQueryRaw;
        replace?: boolean;
        state?: HistoryState;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    force? hash? name? params? path? query? replace? state?

    Properties

    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.

    hash?: string
    name?: Extract<Name, string | symbol>
    params?: RouteMap[Name]["paramsRaw"]
    path?: undefined

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

    query?: LocationQueryRaw
    replace?: boolean

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

    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

    Settings

    Member Visibility

    On This Page

    Properties