Plumile JS API
    Preparing search index...

    Type Alias PreparedRouteSegment<TContext, TPrepared, TVariables, TQueryShape>

    A single active prepared route segment within the current route chain.

    type PreparedRouteSegment<
        TContext = unknown,
        TPrepared extends PrepareResult = PrepareResult,
        TVariables extends ParamData = ParamData,
        TQueryShape extends UnknownQueryShape = UnknownQueryShape,
    > = {
        fullPath?: string;
        highlightId?: string;
        path?: string;
        preparedResource?: PreparedValueResource<TPrepared>;
        querySchema?: Schema;
        redirectTo: string | null;
        render?: RouteRender<TContext, TPrepared, TVariables, TQueryShape>;
        resourcePage?: ResourcePage | null;
        segmentIndex: number;
    }

    Type Parameters

    Index

    Properties

    fullPath? highlightId? path? preparedResource? querySchema? redirectTo render? resourcePage? segmentIndex

    Properties

    fullPath?: string

    Absolute route path for the current segment when known

    highlightId?: string

    Identifier used by developer tooling to map rendered DOM regions

    path?: string

    The path that was matched

    preparedResource?: PreparedValueResource<TPrepared>

    Async resource exposing the route's prepared value

    querySchema?: Schema

    Optional query schema declared by the route segment

    redirectTo: string | null

    Redirect destination if this route should redirect

    render?: RouteRender<TContext, TPrepared, TVariables, TQueryShape>

    Custom render function for this route

    resourcePage?: ResourcePage | null

    Resource page for lazy-loaded components

    segmentIndex: number

    Order of the segment in the active prepared chain

    Settings

    Member Visibility

    On This Page

    Properties