Class Route

A route that can be navigated to.

Example

const routes: Route[] = [
  {
    component: Home
  },
  {
     path: "(?<child>.*)",
     component: ParseRouteParams
  }
]

Constructors

constructor

Properties

basePath? children? component? hooks? name? path? props? querystring? status? traces?

Methods

absolute? test?

Constructors

constructor

  • new Route(config: RouteConfig): Route

    The constructor for the Route class.

    Parameters

    • config: RouteConfig

      An instance of the Route class.

    Returns Route

Properties

OptionalbasePath

basePath?: string

The base path of the route.

This is useful if you want to be declarative about the base path of the route and not depend on the router to determine the base path.

Optionalchildren

children?: Route[]

The children routes of the route.

This is useful if you want to be declarative about the routes that are direct children of this route and not depend on the router to determine the children when there are multiple instances.

Optional

If no value is provided, there are no direct child routes. Routes may be mapped to children routes by the router when there are multiple instances with overlapping basePath values.

Example

const routes: Route[] = [
  ...
  {
    path: "/users",
    children: [
      {
        path: "/:id",
        component: User
      }
    ]
  }
  ...
]

Optionalcomponent

component?: any

The component to render when the route is active.

Optional

If no value is provided, the route will not render a component. This is useful if you want to use pre or post hooks to render a component or snippet conditionally.

Optionalhooks

hooks?: { post?: Hook | Hook[]; pre?: Hook | Hook[] }

Hooks to be run before and after the routes are rendered at the router level (independent of the route hooks if applicable).

Optional

If no value is provided, no hooks will be run.

Optionalname

name?: string | number

The unique identifier of this route. This is useful if you need to track routes outside of the router's scope.

Optional

If no value is provided, the route will not have a name.

Optionalpath

path?: PathType

The path of the route to match against the current path.

Optional

If not provided, the route will match any path as it will be the default route.

Optionalprops

props?: Record<string, any>

The props to pass to the component.

Optional

If a value is provided, the component will receive this value in $props().

Optionalquerystring

querystring?: Query

The query params of the route.

Optional

If no value is provided, there are no query params.

Optionalstatus

status?: number

The status of the route once it has been matched or otherwise processed.

Optionaltraces

traces?: Trace[] = ...

Traces are a list of objects that describe the route's path and query params as it is processed by the router.

Methods

Optionalabsolute

  • absolute(): string

    The absolute path of the route by combining the router's base path and the route's path.

    Returns string

Optionaltest

  • test(path: PathType): Evaluation

    Parse the route against the given path.

    Parameters

    • path: PathType

      The path to parse against the route.

    Returns Evaluation

Settings

Member Visibility

On This Page

Constructors
Properties
Methods