Class Route<TReturn, THandlerParams>

Type Parameters

TReturn extends ResponseObject
THandlerParams extends unknown[] = []

Hierarchy

Route

Constructors

constructor

new Route<TReturn, THandlerParams>(method: "ws" | HTTPMethod | HTTPMethod[], route: string): Route<TReturn, THandlerParams>
Type Parameters
- TReturn extends unknown
- THandlerParams extends unknown[] = []
Parameters
- method: "ws" | HTTPMethod | HTTPMethod[]
- route: string
Returns Route<TReturn, THandlerParams>
- Defined in src/http/routing/Route.ts:208

Properties

`Protected` aliases

aliases: Collection<string> = ...

`Protected` displays

displays: Collection<{
display: string;
stage: "handler" | "post" | "pre";
}> = ...

`Optional` handler

handler?: Constructable<((...x: THandlerParams) => TReturn)>

`Protected` route

route: string

`Static` `Private` compiledGroupStack

compiledGroupStack: RouteGroup[] = []

The current nested group stack. This is used internally when compiling the routes by nested group.

`Static` `Private` registeredGroups

registeredGroups: RouteGroup[] = []

Groups of routes that have been registered with the application.

`Static` `Private` registeredRoutes

registeredRoutes: Route<unknown, unknown[]>[] = []

Routes that have been created and registered in the application.

Methods

alias

alias(name: string): Route<TReturn, THandlerParams>
Set a programmatic name for this route.
Parameters
- name: string
Returns Route<TReturn, THandlerParams>
- Defined in src/http/routing/Route.ts:221

calls

calls<TKey>(key: any, selector: ((x: TKey) => ((...params: THandlerParams) => TReturn))): HandledRoute<TReturn, THandlerParams>
Type Parameters
- TKey
Parameters
- key: any
- selector: ((x: TKey) => ((...params: THandlerParams) => TReturn))
  - - (x: TKey): ((...params: THandlerParams) => TReturn)
    - Parameters
      
      x: TKey
      
      Returns ((...params: THandlerParams) => TReturn)
      
      (...params: THandlerParams): TReturn
      
      Parameters
      
      Rest ...params: THandlerParams
      
      Returns TReturn
Returns HandledRoute<TReturn, THandlerParams>
- Defined in src/http/routing/Route.ts:375

`Private` copyFrom

copyFrom(other: Route<TReturn, any>): void
Parameters
- other: Route<TReturn, any>
Returns void
- Defined in src/http/routing/Route.ts:367

extract

extract(potential: string): undefined | {
[key: string]: string;
}
Given a request path, try to extract this route's paramters from the path string.

Example
For route /foo/:bar/baz and input /foo/bob/baz, extracts:
```
{
    bar: 'bob'
}
```
Parameters
- potential: string
Returns undefined | {
[key: string]: string;
}
- Defined in src/http/routing/Route.ts:307

getAlias

getAlias(): Maybe<string>
Returns Maybe<string>
- Defined in src/http/routing/Route.ts:463

getDisplays

getDisplays(): Collection<{
display: string;
stage: "handler" | "post" | "pre";
}>
Returns Collection<{
display: string;
stage: "handler" | "post" | "pre";
}>
- Defined in src/http/routing/Route.ts:266

getHandlerDisplay

getHandlerDisplay(): Maybe<string>
Returns Maybe<string>
- Defined in src/http/routing/Route.ts:270

getMethods

getMethods(): HTTPMethod[]
Get the string-form methods supported by the route.

Returns HTTPMethod[]
- Defined in src/http/routing/Route.ts:236

getParameters

getParameters(): Collection<ParameterProvidingMiddleware<unknown>>
Returns Collection<ParameterProvidingMiddleware<unknown>>
- Defined in src/http/routing/Route.ts:262

getPostflight

getPostflight(): Collection<ResolvedRouteHandler>
Get postflight middleware for this route.

Returns Collection<ResolvedRouteHandler>
- Defined in src/http/routing/Route.ts:258

getPreflight

getPreflight(): Collection<ResolvedRouteHandler>
Get preflight middleware for this route.

Returns Collection<ResolvedRouteHandler>
- Defined in src/http/routing/Route.ts:251

getRoute

getRoute(): string
Get the string-form of the route.

Returns string
- Defined in src/http/routing/Route.ts:229

handledBy

handledBy(handler: ((...params: THandlerParams) => TReturn)): HandledRoute<TReturn, THandlerParams>
Parameters
- handler: ((...params: THandlerParams) => TReturn)
  - - (...params: THandlerParams): TReturn
    - Parameters
      
      Rest ...params: THandlerParams
      
      Returns TReturn
Returns HandledRoute<TReturn, THandlerParams>
- Defined in src/http/routing/Route.ts:391

hasAlias

hasAlias(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/http/routing/Route.ts:459

input

input<T>(validator: ValidatorFactory<T>): Route<TReturn, [...THandlerParams[], Valid<T>]>
Type Parameters
- T
Parameters
- validator: ValidatorFactory<T>
Returns Route<TReturn, [...THandlerParams[], Valid<T>]>
- Defined in src/http/routing/Route.ts:442

isForWebSocket

isForWebSocket(): boolean
Returns boolean
- Defined in src/http/routing/Route.ts:213

isHandled

isHandled(): this is HandledRoute<TReturn, THandlerParams>
Returns this is HandledRoute<TReturn, THandlerParams>
- Defined in src/http/routing/Route.ts:467

match

match(method: "ws" | HTTPMethod, potential: string): boolean
Returns true if this route matches the given HTTP verb and request path.
Parameters
- method: "ws" | HTTPMethod
- potential: string
Returns boolean
- Defined in src/http/routing/Route.ts:279

parameterMiddleware

parameterMiddleware<T, THandlerArgs>(handler: ParameterProvidingMiddleware<T> | Instantiable<ParameterMiddleware<T, THandlerArgs>>, ...handlerArgs: THandlerArgs): Route<TReturn, [...THandlerParams[], T]>
Type Parameters
- T
- THandlerArgs extends any[] = []
Parameters
- handler: ParameterProvidingMiddleware<T> | Instantiable<ParameterMiddleware<T, THandlerArgs>>
- Rest ...handlerArgs: THandlerArgs
Returns Route<TReturn, [...THandlerParams[], T]>
- Defined in src/http/routing/Route.ts:347

passingRequest

passingRequest(): Route<TReturn, [...THandlerParams[], Request]>
Returns Route<TReturn, [...THandlerParams[], Request]>
- Defined in src/http/routing/Route.ts:455

pipe

pipe<TOut>(builder: ((pipeline: Pipeline<Route<TReturn, THandlerParams>, Route<TReturn, THandlerParams>>) => Pipeline<Route<TReturn, THandlerParams>, TOut>)): TOut
Build and apply a pipeline.
Type Parameters
- TOut
Parameters
- builder: ((pipeline: Pipeline<Route<TReturn, THandlerParams>, Route<TReturn, THandlerParams>>) => Pipeline<Route<TReturn, THandlerParams>, TOut>)
  - - (pipeline: Pipeline<Route<TReturn, THandlerParams>, Route<TReturn, THandlerParams>>): Pipeline<Route<TReturn, THandlerParams>, TOut>
    - Parameters
      
      pipeline: Pipeline<Route<TReturn, THandlerParams>, Route<TReturn, THandlerParams>>
      
      Returns Pipeline<Route<TReturn, THandlerParams>, TOut>
Returns TOut
- Defined in src/http/routing/Route.ts:485

pipeTo

pipeTo<TOut>(pipeline: Pipeline<Route<TReturn, THandlerParams>, TOut>): TOut
Return a new Pipe of this collection.
Type Parameters
- TOut
Parameters
- pipeline: Pipeline<Route<TReturn, THandlerParams>, TOut>
Returns TOut
- Defined in src/http/routing/Route.ts:480

post

post(middleware: Instantiable<Middleware> | Constructable<Middleware>): Route<TReturn, THandlerParams>
Parameters
- middleware: Instantiable<Middleware> | Constructable<Middleware>
Returns Route<TReturn, THandlerParams>
- Defined in src/http/routing/Route.ts:424

pre

pre(middleware: Instantiable<Middleware> | Constructable<Middleware>): Route<TReturn, THandlerParams>
Parameters
- middleware: Instantiable<Middleware> | Constructable<Middleware>
Returns Route<TReturn, THandlerParams>
- Defined in src/http/routing/Route.ts:406

`Private` prepend

prepend(prefix: string): Route<TReturn, THandlerParams>
Prefix the route's path with the given prefix, normalizing / characters.
Parameters
- prefix: string
Returns Route<TReturn, THandlerParams>
- Defined in src/http/routing/Route.ts:490

toString

toString(): string
Cast the route to an intelligible string.

Returns string
- Defined in src/http/routing/Route.ts:472

`Static` any

any(endpoint: string): Route<any, []>
Create a new route on all HTTP verbs, on the given endpoint.
Parameters
- endpoint: string
Returns Route<any, []>
- Defined in src/http/routing/Route.ts:185

`Static` compile

compile(): Promise<Route<unknown, unknown[]>[]>
Load and compile all the registered routes and their groups, accounting for nested groups and resolving handlers.

This function attempts to resolve the route handlers ahead of time to cache them and also expose any handler resolution errors that might happen at runtime.

Returns Promise<Route<unknown, unknown[]>[]>
- Defined in src/http/routing/Route.ts:63

`Static` delete

delete(endpoint: string): Route<any, []>
Create a new DELETE route on the given endpoint.
Parameters
- endpoint: string
Returns Route<any, []>
- Defined in src/http/routing/Route.ts:180

`Static` endpoint

endpoint(method: HTTPMethod | HTTPMethod[], endpoint: string): Route<any, []>
Create a new route on the given endpoint for the given HTTP verb.
Parameters
- method: HTTPMethod | HTTPMethod[]
- endpoint: string
Returns Route<any, []>
- Defined in src/http/routing/Route.ts:137

`Static` get

get(endpoint: string): Route<any, []>
Create a new GET route on the given endpoint.
Parameters
- endpoint: string
Returns Route<any, []>
- Defined in src/http/routing/Route.ts:160

`Static` group

group(prefix: string, group: (() => void | Promise<void>)): RouteGroup
Create a new route group with the given prefix.
Parameters
- prefix: string
- group: (() => void | Promise<void>)
  - - (): void | Promise<void>
    - Returns void | Promise<void>
Returns RouteGroup
- Defined in src/http/routing/Route.ts:190

`Static` patch

patch(endpoint: string): Route<any, []>
Create a new PATCH route on the given endpoint.
Parameters
- endpoint: string
Returns Route<any, []>
- Defined in src/http/routing/Route.ts:175

`Static` post

post(endpoint: string): Route<any, []>
Create a new POST route on the given endpoint.
Parameters
- endpoint: string
Returns Route<any, []>
- Defined in src/http/routing/Route.ts:165

`Static` put

put(endpoint: string): Route<any, []>
Create a new PUT route on the given endpoint.
Parameters
- endpoint: string
Returns Route<any, []>
- Defined in src/http/routing/Route.ts:170

`Static` registerGroup

registerGroup(group: RouteGroup): void
Register a route group handler.
Parameters
- group: RouteGroup
Returns void
- Defined in src/http/routing/Route.ts:52

`Static` socket

socket(endpoint: string): SocketRouteBuilder
Create a new WebSocket route on the given endpoint.
Parameters
- endpoint: string
Returns SocketRouteBuilder
- Defined in src/http/routing/Route.ts:145

Class Route<TReturn, THandlerParams>

Type Parameters

TReturn extends ResponseObject

THandlerParams extends unknown[] = []

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TReturn extends unknown

THandlerParams extends unknown[] = []

Parameters

method: "ws" | HTTPMethod | HTTPMethod[]

route: string

Returns Route<TReturn, THandlerParams>

Properties

Protected aliases

Protected displays

Optional handler

Protected method

Protected parameters

Protected postflight

Protected preflight

Protected route

Static Private compiledGroupStack

Static Private registeredGroups

Static Private registeredRoutes

Methods

alias

Parameters

name: string

Returns Route<TReturn, THandlerParams>

calls

Type Parameters

TKey

Parameters

key: any

selector: ((x: TKey) => ((...params: THandlerParams) => TReturn))

Parameters

x: TKey

Returns ((...params: THandlerParams) => TReturn)

Parameters

Rest ...params: THandlerParams

Returns TReturn

Returns HandledRoute<TReturn, THandlerParams>

Private copyFrom

Parameters

other: Route<TReturn, any>

Returns void

extract

Example

Parameters

potential: string

Returns undefined | { [key: string]: string; }

getAlias

Returns Maybe<string>

getDisplays

Returns Collection<{ display: string; stage: "handler" | "post" | "pre"; }>

getHandlerDisplay

Returns Maybe<string>

getMethods

Returns HTTPMethod[]

getParameters

Returns Collection<ParameterProvidingMiddleware<unknown>>

getPostflight

Returns Collection<ResolvedRouteHandler>

getPreflight

Returns Collection<ResolvedRouteHandler>

getRoute

Returns string

handledBy

Parameters

handler: ((...params: THandlerParams) => TReturn)

Parameters

Rest ...params: THandlerParams

Returns TReturn

Returns HandledRoute<TReturn, THandlerParams>

`Protected` aliases

`Protected` displays

`Optional` handler

`Protected` method

`Protected` parameters

`Protected` postflight

`Protected` preflight

`Protected` route

`Static` `Private` compiledGroupStack

`Static` `Private` registeredGroups

`Static` `Private` registeredRoutes

`Rest` ...params: THandlerParams

`Private` copyFrom

Returns undefined | {
[key: string]: string;
}

Returns Collection<{
display: string;
stage: "handler" | "post" | "pre";
}>

`Rest` ...params: THandlerParams

`Rest` ...handlerArgs: THandlerArgs

`Private` prepend

`Static` any

`Static` compile

`Static` delete

`Static` endpoint