Class Route

Represents a route. Internally, it stores a chain of handlers.

The route can be matched against a path and the handlers will be called in order they appear in the constructor.

It also parses the path and stores the parameters in the param ({@link RouteContext#param}) field of a RouteContext instance.

Hierarchy

Route

Index

Constructors

constructor

Methods

Constructors

constructor

new Route(pattern: string, handlers: RouteHandler[], matchingOptions?: RouteMatchingOptions): Route

- Defined in lib/route.ts:32
Parameters
- pattern: string
- handlers: RouteHandler[]
- Optional matchingOptions: RouteMatchingOptions
Returns Route

Methods

addHandler

addHandler(...handlers: RouteHandler[]): void

- Defined in lib/route.ts:73
Adds additional handlers to the route.

Parameters
- Rest ...handlers: RouteHandler[]
Returns void

handle

handle(routeContext: RouteContext, navigationContext: NavigationContext): undefined | false

- Defined in lib/route.ts:92
Finds a handler.

If the navigation is handled already, it will throw an error.

Some properties of the context may be modified by the route handlers in this route.

throws
{@link RouterError} If the context is already handled.

Parameters
- routeContext: RouteContext
  
  provides the context for the matching.
- navigationContext: NavigationContext
  
  to control the flow of navigation
Returns undefined | false
true if the route was able to handle the context, false otherwise.

Generated using TypeDoc