Class RouterInstance

constructor

• new RouterInstance(
      config: RouterInstanceConfig,
      applyFn: ApplyFn,
  ): RouterInstance

  The constructor for the RouterInstance class.

  Parameters

  • config: RouterInstanceConfig

    The config for the router instance.
  • applyFn: ApplyFn

    The apply function for the router instance.

  Returns RouterInstance

applyFn

config

current

handlers

id

navigating

routes

routesArray

• get routesArray(): Route[]

  Get routes as an array for serialization purposes.

  Returns Route[]

  The routes as an array.

deregister

• deregister(span?: Span): void

  Deregister a router instance by removing it from the registry and restoring the original history methods.

  This is called when a router instance is removed from the DOM triggered by the onDestroy lifecycle method of the router instance.

  Parameters

  • Optionalspan: Span

  Returns void

evaluateHooks

• evaluateHooks(route: RouteResult, hooks: Hook | Hook[]): Promise<boolean>

  Parameters

  • route: RouteResult
  • hooks: Hook | Hook[]

  Returns Promise<boolean>

get

• get(path: string, query?: Query, span?: Span): Promise<RouteResult>

  Retrieve a route for a given path.

  Parameters

  • path: string

    The path to get the route for.
  • Optionalquery: Query
  • Optionalspan: Span

  Returns Promise<RouteResult>

  The matched route for the given path.

handleStateChange

• handleStateChange(url: string, span?: Span): Promise<void>

  Process a state change event from the browser history API.

  This method is called when the browser history API is used to change the current route via the pushState, replaceState, or popState methods.

  The method will evaluate the route for the given path and query, and apply the route to the router instance to ultimately call the applyFn function on the downstream router component to render the new route.

  Parameters

  • url: string
  • Optionalspan: Span

  Returns Promise<void>

  Optional

  The span to attach traces to. If not provided, a new span will be created.

toJSON

• toJSON(): any

  Custom JSON serialization to handle Set objects properly.

  Returns any

  The serializable representation of the router instance.