Route | The Extollo Framework

A class that can be used to build and reference dynamic routes in the application.

Routes can be defined in nested groups, with prefixes and middleware handlers.

example

Route.post('/api/v1/ping', (request: Request) => {
    return 'pong!'
})

Route.group('/api/v2', () => {
    Route.get('/status', 'controller::api:v2:Status.getStatus').pre('auth:UserOnly')
})

Hierarchy

AppClass
- Route

Index

Constructors

constructor

Properties

Accessors

appClassApplication

Constructors

constructor

new Route(method: HTTPMethod | HTTPMethod[], handler: RouteHandler, route: string): Route

Overrides AppClass.constructor
- Defined in src/http/routing/Route.ts:219
Parameters
- method: HTTPMethod | HTTPMethod[]
- handler: RouteHandler
- route: string
Returns Route

Properties

aliases

aliases: string[] = []

Programmatic aliases of this route.

Protected Optional compiledHandler

compiledHandler: ResolvedRouteHandler

Pre-compiled route handlers for the post-middleware for this route.

Protected Optional compiledPostflight

compiledPostflight: ResolvedRouteHandler[]

Pre-compiled route handler for the main route handler for this route.

Protected Optional compiledPreflight

compiledPreflight: ResolvedRouteHandler[]

Pre-compiled route handlers for the pre-middleware for this route.

Protected Readonly handler

handler: RouteHandler

Protected method

method: HTTPMethod | HTTPMethod[]

Protected middlewares

middlewares: Collection<{ handler: RouteHandler; stage: "post" | "pre" }> = ...

Middlewares that should be applied to this route.

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[] = []

Routes that have been created and registered in the application.

Accessors

Private appClassApplication

get appClassApplication(): Application

- Defined in src/lifecycle/AppClass.ts:31
The global application instance.

Returns Application

Methods

alias

alias(name: string): Route

- Defined in src/http/routing/Route.ts:238
Set a programmatic name for this route.

Parameters
- name: string
Returns Route

Protected app

app(): Application

Inherited from AppClass.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

Private appendMiddleware

appendMiddleware(def: { handler: RouteHandler; stage: "post" | "pre" }): void

- Defined in src/http/routing/Route.ts:408
Add the given middleware item to the end of the postflight handlers.

Parameters
- def: { handler: RouteHandler; stage: "post" | "pre" }
  - handler: RouteHandler
  - stage: "post" | "pre"
Returns void

Private compileResolvedHandler

compileResolvedHandler(): ResolvedRouteHandler

- Defined in src/http/routing/Route.ts:416
Resolve and return the route handler for this route.

Returns ResolvedRouteHandler

Protected container

container(): Container

Inherited from AppClass.container
- Defined in src/lifecycle/AppClass.ts:41
Get the global Container.

Returns Container

extract

extract(potential: string): undefined | {}

- Defined in src/http/routing/Route.ts:300
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 | {}

getBoundMethod

getBoundMethod(methodName: string): (...args: any[]) => any

Inherited from AppClass.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55
Get the method with the given name from this class, bound to this class.

Parameters
- methodName: string
Returns (...args: any[]) => any

function
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

getDisplayableHandler

getDisplayableHandler(): string

- Defined in src/http/routing/Route.ts:267
Get the string-form of the route handler.

Returns string

getMethod

getMethod(): HTTPMethod | HTTPMethod[]

- Defined in src/http/routing/Route.ts:253
Get the string-form method of the route.

Returns HTTPMethod | HTTPMethod[]

getMiddlewares

getMiddlewares(): Collection<{ handler: RouteHandler; stage: "post" | "pre" }>

- Defined in src/http/routing/Route.ts:260
Get collection of applied middlewares.

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

getRoute

getRoute(): string

- Defined in src/http/routing/Route.ts:246
Get the string-form of the route.

Returns string

Protected make

make<T>(target: any, ...parameters: any[]): T

Inherited from AppClass.make
- Defined in src/lifecycle/AppClass.ts:46
Call the make() method on the global container.

Type parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T

match

match(method: HTTPMethod, potential: string): boolean

- Defined in src/http/routing/Route.ts:276
Returns true if this route matches the given HTTP verb and request path.

Parameters
- method: HTTPMethod
- potential: string
Returns boolean

post

post(middleware: RouteHandler): Route

- Defined in src/http/routing/Route.ts:381
Register the given middleware as a postflight handler for this route.

Parameters
- middleware: RouteHandler
Returns Route

pre

pre(middleware: RouteHandler): Route

- Defined in src/http/routing/Route.ts:371
Register the given middleware as a preflight handler for this route.

Parameters
- middleware: RouteHandler
Returns Route

Private prepend

prepend(prefix: string): Route

- Defined in src/http/routing/Route.ts:391
Prefix the route's path with the given prefix, normalizing / characters.

Parameters
- prefix: string
Returns Route

Private prependMiddleware

prependMiddleware(def: { handler: RouteHandler; stage: "post" | "pre" }): void

- Defined in src/http/routing/Route.ts:403
Add the given middleware item to the beginning of the preflight handlers.

Parameters
- def: { handler: RouteHandler; stage: "post" | "pre" }
  - handler: RouteHandler
  - stage: "post" | "pre"
Returns void

resolveHandler

resolveHandler(): ResolvedRouteHandler

- Defined in src/http/routing/Route.ts:362
Try to pre-compile and return the main handler for this route.

Returns ResolvedRouteHandler

Private resolveMiddlewareHandlersForStage

resolveMiddlewareHandlersForStage(stage: "post" | "pre"): ResolvedRouteHandler[]

- Defined in src/http/routing/Route.ts:462
Resolve and return the route handlers for the given pre- or post-flight stage.

Parameters
- stage: "post" | "pre"
Returns ResolvedRouteHandler[]

resolvePostflight

resolvePostflight(): ResolvedRouteHandler[]

- Defined in src/http/routing/Route.ts:351
Try to pre-compile and return the postflight handlers for this route.

Returns ResolvedRouteHandler[]

resolvePreflight

resolvePreflight(): ResolvedRouteHandler[]

- Defined in src/http/routing/Route.ts:340
Try to pre-compile and return the preflight handlers for this route.

Returns ResolvedRouteHandler[]

toString

toString(): string

- Defined in src/http/routing/Route.ts:504
Cast the route to an intelligible string.

Returns string

Static any

any(definition: string, handler: RouteHandler): Route

- Defined in src/http/routing/Route.ts:195
Create a new route on all HTTP verbs, on the given endpoint.

Parameters
- definition: string
- handler: RouteHandler
Returns Route

Static compile

compile(): Promise<Route[]>

- Defined in src/http/routing/Route.ts:75
Load and compile all of 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[]>

Static delete

delete(definition: string, handler: RouteHandler): Route

- Defined in src/http/routing/Route.ts:190
Create a new DELETE route on the given endpoint.

Parameters
- definition: string
- handler: RouteHandler
Returns Route

Static endpoint

endpoint(method: HTTPMethod | HTTPMethod[], definition: string, handler: RouteHandler): Route

- Defined in src/http/routing/Route.ts:159
Create a new route on the given endpoint for the given HTTP verb.

Parameters
- method: HTTPMethod | HTTPMethod[]
- definition: string
- handler: RouteHandler
Returns Route

Static get

get(definition: string, handler: RouteHandler): Route

- Defined in src/http/routing/Route.ts:170
Create a new GET route on the given endpoint.

Parameters
- definition: string
- handler: RouteHandler
Returns Route

Static group

group(prefix: string, group: () => void | Promise<void>): RouteGroup

- Defined in src/http/routing/Route.ts:200
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

Static patch

patch(definition: string, handler: RouteHandler): Route

- Defined in src/http/routing/Route.ts:185
Create a new PATCH route on the given endpoint.

Parameters
- definition: string
- handler: RouteHandler
Returns Route

Static post

post(definition: string, handler: RouteHandler): Route

- Defined in src/http/routing/Route.ts:175
Create a new POST route on the given endpoint.

Parameters
- definition: string
- handler: RouteHandler
Returns Route

Static put

put(definition: string, handler: RouteHandler): Route

- Defined in src/http/routing/Route.ts:180
Create a new PUT route on the given endpoint.

Parameters
- definition: string
- handler: RouteHandler
Returns Route

Static registerGroup

registerGroup(group: RouteGroup): void

- Defined in src/http/routing/Route.ts:64
Register a route group handler.

Parameters
- group: RouteGroup
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

method: HTTPMethod | HTTPMethod[]

handler: RouteHandler

route: string

Returns Route

Properties

aliases

Protected Optional compiledHandler

Protected Optional compiledPostflight

Protected Optional compiledPreflight

Protected Readonly handler

Protected method

Protected middlewares

Protected route

Static Private compiledGroupStack

Static Private registeredGroups

Static Private registeredRoutes

Accessors

Private appClassApplication

Returns Application

Methods

alias

Parameters

name: string

Returns Route

Protected app

Returns Application

Private appendMiddleware

Parameters

def: { handler: RouteHandler; stage: "post" | "pre" }

handler: RouteHandler

stage: "post" | "pre"

Returns void

Private compileResolvedHandler

Returns ResolvedRouteHandler

Protected container

Returns Container

extract

Parameters

potential: string

Returns undefined | {}

getBoundMethod

Parameters

methodName: string

Returns (...args: any[]) => any

Parameters

Rest ...args: any[]

Returns any

getDisplayableHandler

Returns string

getMethod

Returns HTTPMethod | HTTPMethod[]

getMiddlewares

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

getRoute

Returns string

Protected make

Type parameters

T

Parameters

target: any

Rest ...parameters: any[]

Returns T

match

Parameters

method: HTTPMethod

potential: string

Returns boolean

post

Parameters

middleware: RouteHandler

Returns Route