Type Alias PrepareParams<TContext, TVariables, TQueryShape>

Parameters passed to a route's prepare function.

type PrepareParams<
    TContext,
    TVariables extends ParamData,
    TQueryShape extends UnknownQueryShape = UnknownQueryShape,
> = {
    context: TContext;
    match: RouterMatchedRoute<TVariables>;
    matchedRoute: FlatRoute<TVariables>;
    query: TQueryShape;
    resourcePage?: ResourcePage | null;
    variables: TVariables;
}

Type Parameters

TContext
TVariables extends ParamData
Route parameter types extracted from the URL path
TQueryShape extends UnknownQueryShape = UnknownQueryShape

Index

Properties

context match matchedRoute query resourcePage? variables

Properties

context

context: TContext

Router-level context

match

match: RouterMatchedRoute<TVariables>

The matched route with extracted parameters

matchedRoute

matchedRoute: FlatRoute<TVariables>

The flat route that was matched

query

query: TQueryShape

Typed query object

`Optional`resourcePage

resourcePage?: ResourcePage | null

Resource page for lazy-loaded components

variables

variables: TVariables

Extracted URL parameters