Interface RouteResolutionApi

resolve

• resolve<TParams extends AnyRouteRefParams>(
      anyRouteRef:
          | RouteRef<TParams>
          | SubRouteRef<TParams>
          | ExternalRouteRef<TParams>,
      options?: { sourcePath?: string },
  ): RouteFunc<TParams> | undefined

  Type Parameters

  • TParams extends AnyRouteRefParams

  Parameters

  • anyRouteRef: RouteRef<TParams> | SubRouteRef<TParams> | ExternalRouteRef<TParams>
  • Optionaloptions: { sourcePath?: string }

    • OptionalsourcePath?: string

      An absolute path to use as a starting point when resolving the route. If no path is provided the route will be resolved from the root of the app.

  Returns RouteFunc<TParams> | undefined