Class Resolver<T, R, C>

constructor

• new Resolver<T, R, C>(routes, options?): Resolver<T, R, C>

• Type Parameters

  • T = unknown
  • R extends object = EmptyObject
  • C extends object = EmptyObject

  Parameters

  • routes: Route<T, R, C> | readonly Route<T, R, C>[]
  • Optionaloptions: Readonly<{
        baseUrl?: string;
        context?: RouteContext<T, R, C>;
        errorHandler?: ErrorHandlerCallback<T>;
        resolveRoute?: ResolveRouteCallback<T, R, C>;
    }>

  Returns Resolver<T, R, C>

ReadonlybaseUrl

Optional ReadonlyerrorHandler

ReadonlyresolveRoute

context

• get context(): RouteContext<T, R, C>

• The current route context.

  Returns RouteContext<T, R, C>

root

• get root(): Route<T, R, C>

• The root route.

  Returns Route<T, R, C>

getRoutes

• getRoutes(): readonly Route<T, R, C>[]

• Returns the current list of routes (as a shallow copy). Adding / removing routes to / from the returned array does not affect the routing config, but modifying the route objects does.

  Returns readonly Route<T, R, C>[]

removeRoutes

• removeRoutes(): void

• Removes all existing routes from the routing config.

  Returns void

resolve

• resolve(pathnameOrContext): Promise<ActionResult<RouteContext<T, R, C>>>

• Asynchronously resolves the given pathname, i.e. finds all routes matching the pathname and tries resolving them one after another in the order they are listed in the routes config until the first non-null result.

  Returns a promise that is fulfilled with the return value of an object that consists of the first route handler result that returns something other than null or undefined and context used to get this result.

  If no route handlers return a non-null result, or if no route matches the given pathname the returned promise is rejected with a 'page not found' Error.

  Parameters

  • pathnameOrContext: string | ResolveContext<C>

    the pathname to resolve or a context object with a pathname property and other properties to pass to the route resolver functions.

  Returns Promise<ActionResult<RouteContext<T, R, C>>>

setRoutes

• setRoutes(routes): object

• Sets the routing config (replacing the existing one).

  Parameters

  • routes: Route<T, R, C> | readonly Route<T, R, C>[]

    a single route or an array of those (the array is shallow copied)

  Returns object