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

    Interface RouteLocationTyped<RouteMap, Name>

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

    interface RouteLocationTyped<
        RouteMap extends RouteMapGeneric,
        Name extends keyof RouteMap,
    > {
        fullPath: string;
        hash: string;
        matched: RouteRecordNormalized[];
        meta: RouteMeta;
        name: Extract<Name, string | symbol>;
        params: RouteMap[Name]["params"];
        path: string;
        query: LocationQuery;
        redirectedFrom: RouteLocationGeneric | undefined;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    fullPath hash matched meta name params path query redirectedFrom

    Properties

    fullPath: string

    The whole location including the search and hash. This string is percentage encoded.

    hash: string

    Hash of the current location. If present, starts with a #.

    matched: RouteRecordNormalized[]

    Array of RouteRecord containing components as they were passed when adding records. It can also contain redirect records. This can't be used directly. This property is non-enumerable.

    meta: RouteMeta

    Merged meta properties from all the matched route records.

    name: Extract<Name, string | symbol>

    Name of the matched record

    params: RouteMap[Name]["params"]

    Object of decoded params extracted from the path.

    path: string

    Percentage encoded pathname section of the URL.

    query: LocationQuery

    Object representation of the search property of the current location.

    redirectedFrom: RouteLocationGeneric | undefined

    Contains the location we were initially trying to access before ending up on the current location.

    Settings

    Member Visibility

    On This Page

    Properties