Plumile JS API
    Preparing search index...

    Type Alias RouteEntry<TVariables, S, TContext>

    Complete route entry representing the current router state.

    type RouteEntry<
        TVariables extends ParamData,
        S extends Schema | undefined = Schema | undefined,
        TContext = unknown,
    > = {
        activeQuerySchema?: S;
        context: TContext;
        filterDiagnostics?: Diagnostic[];
        filters?: S extends Schema ? InferFilters<S> : UnknownFilters;
        forceRerender: boolean;
        location: Location;
        preparedMatch: PreparedRouteChain<TVariables, TContext>;
        query: RawQuery;
        rawSearch?: string;
        route: RouterMatchedRoute<TVariables> | null;
    }

    Type Parameters

    • TVariables extends ParamData

      Route parameter types extracted from the URL path

    • S extends Schema | undefined = Schema | undefined
    • TContext = unknown
    Index

    Properties

    activeQuerySchema? context filterDiagnostics? filters? forceRerender location preparedMatch query rawSearch? route

    Properties

    activeQuerySchema?: S

    Deepest active query schema (FilterSchema from @plumile/filter-query) for current matched route

    context: TContext

    Router-level context resolved for this entry

    filterDiagnostics?: Diagnostic[]

    Diagnostics from filter parsing (if any)

    filters?: S extends Schema ? InferFilters<S> : UnknownFilters

    Parsed filters object derived from the deepest active querySchema (if any)

    forceRerender: boolean

    Whether to force a re-render even if the path hasn't changed

    location: Location

    Current browser location

    preparedMatch: PreparedRouteChain<TVariables, TContext>

    The prepared match with loaded data and components

    query: RawQuery

    Parsed raw query parameters (values aggregated; duplicates => array)

    rawSearch?: string

    Raw search string (query part) of the location for change detection

    route: RouterMatchedRoute<TVariables> | null

    The matched route or null if no match

    Settings

    Member Visibility

    On This Page

    Properties