Class Router<T, R, C>

constructor

• new Router<T, R, C>(routes, optionsOrRouter?): Router<T, R, C>

• Constructs a router instance.

  Type Parameters

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

  Parameters

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

    The root route or a list of routes.
  • optionsOrRouter: Router<T, R, C> | RouterOptions<T> = {}

    The optional parameter to customize the router behavior. Can also be another router instance to create a new router based on the existing one.

  Returns Router<T, R, C>

ReadonlybaseURL

https://example.com/path/to/my/root
Copy

Readonlyroutes

resolve

• resolve(path): Promise<undefined | null | T>

• Resolves the provided path based on the established routes.

  Parameters

  • path: string | URL

    The path to be resolved. It can be either an absolute URL or a string path relative to the RouterOptions.baseURL.

  Returns Promise<undefined | null | T>
• resolve(path, context): Promise<undefined | null | T>

• Resolves the provided path based on the established routes.

  Parameters

  • path: string | URL

    The path to be resolved. It can be either an absolute URL or a string path relative to the RouterOptions.baseURL.
  • context: C extends EmptyObject
        ? never
        : C

    Any data that needs to be sent to Route.action. The type of this parameter should match the C type parameter of the Route. If C is not provided or is equal to EmptyObject, setting this parameter is forbidden.

  Returns Promise<undefined | null | T>