Interface CustomRoute<TMeans, TRoute>

Router configuration with custom route builder.

Type Parameters

TMeans = HttpMeans

A type of incoming HTTP request processing means.
TRoute extends PathRoute = URLRoute

Hierarchy

Base<TMeans, TRoute>
- CustomRoute

Index

Methods

buildRoute routePattern?

Methods

buildRoute

buildRoute(context): TRoute
Builds a route based on incoming request.
Parameters
- context: RequestContext<TMeans>
  
  Request processing context.
Returns TRoute
New URL route.
Default
```
Builds a route based on {@link HttpMeans.Addresses.url request URL} (for HTTP requests).
```
- Defined in router/src/router-config.ts:67

`Optional` routePattern

routePattern(pattern, context): RoutePattern<TRoute>
A parser of route pattern string.

The this parameter is bound to current request processing means.
Parameters
- pattern: string
  
  Pattern string in supported format.
- context: RequestContext<TMeans & RouterMeans<TRoute>>
  
  Current request processing context.
Returns RoutePattern<TRoute>

Default
Supports patterns in simple format (simpleRoutePattern()).
Inherited from Base.routePattern
- Defined in router/src/router-config.ts:34

Generated using TypeDoc