Class Route<Parent, Params, Data, Context>

constructor

• new Route<Parent, Params, Data, Context>(parent, options?): Route<Parent, Params, Data, Context>

• Creates a new instance of a Route.

  Type Parameters

  • Parent extends null | Route<any, any, Context, any> = any

    A parent route or null if there is no parent.
  • Params extends void | object = any

    Route params.
  • Data = any

    Data loaded by a route.
  • Context = any

    A context provided by a Router for a RouteOptions.loader.

  Parameters

  • parent: Parent

    A parent route or null if there is no parent.
  • options: RouteOptions<Params, Data, Context> = {}

    Route options.

  Returns Route<Parent, Params, Data, Context>

errorComponent

getComponent

loader

loadingAppearance

loadingComponent

notFoundComponent

paramsAdapter

Readonlyparent

pathnameTemplate

getLocation

• getLocation(params, options?): Location

• Returns a route location.

  Parameters

  • params: Parent extends Route<any, any, any, any>
        ? {
            [K in string | number | symbol]: (Parent<Parent>["_params"] & Params)[K]
        }
        : Params

    Route params.
  • Optionaloptions: LocationOptions

    Location options.

  Returns Location

prefetch

• prefetch(params, context): void

• Prefetches a component and data of this route and its ancestors.

  Parameters

  • params: Parent extends Route<any, any, any, any>
        ? {
            [K in string | number | symbol]: (Parent<Parent>["_params"] & Params)[K]
        }
        : Params

    Route params.
  • context: 0 extends 1 & Context
        ? void
        : never

    A context provided to a RouteOptions.loader.

  Returns void
• prefetch(params, context): void

• Prefetches a component and data of this route and its ancestors.

  Parameters

  • params: Parent extends Route<any, any, any, any>
        ? {
            [K in string | number | symbol]: (Parent<Parent>["_params"] & Params)[K]
        }
        : Params

    Route params.
  • context: Context

    A context provided to a RouteOptions.loader.

  Returns void