Class Router

Router class.

Hierarchy

Route
- Router

Index

Constructors

constructor

new Router(): Router
Returns Router
Overrides Route.constructor
- Defined in mojo.js-main/src/router.ts:47

Properties

_lookupIndex

_lookupIndex: undefined | RouteIndex = undefined

_parent

_parent: undefined | WeakRef<Route> = undefined

_root

_root: undefined | WeakRef<Router> = undefined

cache

cache: null | Cache<Plan> = ...

Routing cache.

children

children: Route[] = []

The children of this route, used for nesting routes.

conditions

conditions: Record<string, RouteCondition> = {}

Contains all available conditions.

controllerPaths

controllerPaths: string[] = []

Directories to look for controllers in, first one has the highest precedence.

controllers

controllers: Record<string, any> = {}

Already loaded controllers.

customName

customName: undefined | string = undefined

Custom route name, if defined.

defaultName

defaultName: undefined | string = undefined

Default route name.

methods

methods: string[] = []

Restrict HTTP methods this route is allowed to handle, defaults to no restrictions.

pattern

pattern: Pattern = ...

Pattern for this route.

requirements

requirements: Record<string, any>[] = []

Activate conditions for this route.

types

types: Record<string, PlaceholderType> = ...

Registered placeholder types, by default only num is already defined.

underRoute

underRoute: boolean = false

Allow under semantics for this route.

websocketRoute

websocketRoute: boolean = false

Activate websocket semantics for this route.

Accessors

parent

get parent(): undefined | Route
The parent of this route.

Returns undefined | Route
Inherited from Route.parent
- Defined in mojo.js-main/src/router/route.ts:152
set parent(parent): void
Parameters
- parent: undefined | Route
Returns void
Inherited from Route.parent
- Defined in mojo.js-main/src/router/route.ts:156

root

get root(): undefined | Router
Return the Router object this route is a descendant of.

Returns undefined | Router
Inherited from Route.root
- Defined in mojo.js-main/src/router/route.ts:231
set root(root): void
Parameters
- root: undefined | Router
Returns void
Inherited from Route.root
- Defined in mojo.js-main/src/router/route.ts:235

Methods

_branch

_branch(): (Route | Router)[]
Returns (Route | Router)[]
Inherited from Route._branch
- Defined in mojo.js-main/src/router/route.ts:302

_getLookupIndex

_getLookupIndex(): RouteIndex
Returns RouteIndex
- Defined in mojo.js-main/src/router.ts:177

_getPlan

_getPlan(ctx): Promise<null | Plan>
Parameters
- ctx: MojoContext
Returns Promise<null | Plan>
- Defined in mojo.js-main/src/router.ts:144

_walk

_walk(plan, route, spec): Promise<boolean>
Parameters
- plan: Plan
- route: Route
- spec: RouteSpec
Returns Promise<boolean>
- Defined in mojo.js-main/src/router.ts:196

addChild

addChild(child): Route
Add a child to this route.
Parameters
- child: Route
Returns Route
Inherited from Route.addChild
- Defined in mojo.js-main/src/router/route.ts:48

addCondition

addCondition(name, fn): Router
Register a condition.
Parameters
- name: string
- fn: RouteCondition
Returns Router
- Defined in mojo.js-main/src/router.ts:55

addType

addType(name, value): Router
Register a placeholder type.
Parameters
- name: string
- value: PlaceholderType
Returns Router
- Defined in mojo.js-main/src/router.ts:63

any

any(...args): Route

Generate route matching any of the listed HTTP request methods or all.

Parameters

Rest ...args: AnyArguments

Returns Route

Example

// Route with pattern and destination
route.any('/user').to('User#whatever');

// Route with HTTP methods, pattern, restrictive placeholders and destination
route.any(['DELETE', 'PUT'], '/:foo', {foo: /\w+/}).to('Foo#bar');

// Route with pattern, name and destination
route.any('/:foo').name('foo_route').to('Foo#bar');

// Route with pattern, condition and destination
route.any('/').requires({agent: /Firefox/}).to('Foo#bar');

// Route with pattern and a closure as destination
route.any('/:foo', async ctx => ctx.render({text: 'Hello World!'}));

delete

delete(...args): Route
Generate route matching only DELETE requests.
Parameters
- Rest ...args: RouteArguments
Returns Route
Example
```
// Route with destination
route.delete('/user').to('User#remove');
```
Inherited from Route.delete
- Defined in mojo.js-main/src/router/route.ts:100

dispatch

dispatch(ctx): Promise<boolean>
Match routes and dispatch to actions with and without controllers.
Parameters
- ctx: MojoContext
Returns Promise<boolean>
- Defined in mojo.js-main/src/router.ts:71

find

find(name): null | Route
Find child route by name, custom names have precedence over automatically generated ones.
Parameters
- name: string
Returns null | Route
- Defined in mojo.js-main/src/router.ts:109

get

get(...args): Route
Generate route matching only GET requests.
Parameters
- Rest ...args: RouteArguments
Returns Route
Example
```
// Route with destination
route.get('/user').to('User#show');
```
Inherited from Route.get
- Defined in mojo.js-main/src/router/route.ts:110

hasWebSocket

hasWebSocket(): boolean
Check if this route has a WebSocket ancestor and cache the result for future checks.

Returns boolean
Inherited from Route.hasWebSocket
- Defined in mojo.js-main/src/router/route.ts:117

isEndpoint

isEndpoint(): boolean
Check if this route qualifies as an endpoint.

Returns boolean
Inherited from Route.isEndpoint
- Defined in mojo.js-main/src/router/route.ts:126

lookup

lookup(name): null | Route
Find route by name and cache all results for future lookups.
Parameters
- name: string
Returns null | Route
- Defined in mojo.js-main/src/router.ts:116

name

name(name): Router
The name of this route, defaults to an automatically generated name based on the route pattern. Note that the name current is reserved for referring to the current route.
Parameters
- name: string
Returns Router
Inherited from Route.name
- Defined in mojo.js-main/src/router/route.ts:134

options

options(...args): Route
Generate route matching only OPTIONS requests.
Parameters
- Rest ...args: RouteArguments
Returns Route
Example
```
// Route with destination
route.options('/user').to('User#overview');
```
Inherited from Route.options
- Defined in mojo.js-main/src/router/route.ts:145

patch

patch(...args): Route
Generate route matching only PATCH requests.
Parameters
- Rest ...args: RouteArguments
Returns Route
Example
```
// Route with destination
route.patch('/user').to('User#update');
```
Inherited from Route.patch
- Defined in mojo.js-main/src/router/route.ts:166

plot

plot(spec): Promise<null | Plan>
Plot a route.
Parameters
- spec: RouteSpec
Returns Promise<null | Plan>
- Defined in mojo.js-main/src/router.ts:124

post

post(...args): Route
Generate route matching only POST requests.
Parameters
- Rest ...args: RouteArguments
Returns Route
Example
```
// Route with destination
route.post('/user').to('User#create');
```
Inherited from Route.post
- Defined in mojo.js-main/src/router/route.ts:176

put

put(...args): Route
Generate route matching only PUT requests.
Parameters
- Rest ...args: RouteArguments
Returns Route
Example
```
// Route with destination
route.put('/user').to('User#replace');
```
Inherited from Route.put
- Defined in mojo.js-main/src/router/route.ts:186

remove

remove(): Router
Remove route from parent.

Returns Router
Inherited from Route.remove
- Defined in mojo.js-main/src/router/route.ts:193

render

render(values?): string
Render route with parameters into a path.
Parameters
- values: {} = {}
Returns string
Inherited from Route.render
- Defined in mojo.js-main/src/router/route.ts:204

requires

requires(condition, requirement): Router
Activate conditions for this route. Note that this automatically disables the routing cache, since conditions are too complex for caching.
Parameters
- condition: string
- requirement: Record<string, any>
Returns Router
Inherited from Route.requires
- Defined in mojo.js-main/src/router/route.ts:218

suggestedMethod

suggestedMethod(): string
Suggested HTTP method for reaching this route, GET and POST are preferred.

Returns string
Inherited from Route.suggestedMethod
- Defined in mojo.js-main/src/router/route.ts:242

to

to(...targets): Router
Set default parameters for this route.
Parameters
- Rest ...targets: (string | Record<string, any> | MojoAction)[]
Returns Router
Inherited from Route.to
- Defined in mojo.js-main/src/router/route.ts:258

under

under(...args): Route
Generate route for a nested route with its own intermediate destination.
Parameters
- Rest ...args: AnyArguments
Returns Route
Example
```
// Intermediate destination and prefix shared between two routes
const auth = app.under('/user').to('User#auth');
auth.get('/show').to('User#show');
auth.post('/create').to('User#create');
```
Inherited from Route.under
- Defined in mojo.js-main/src/router/route.ts:284

warmup

warmup(): Promise<void>
Prepare controllers for routing.

Returns Promise<void>
- Defined in mojo.js-main/src/router.ts:140

websocket

websocket(...args): Route
Generate route matching only WebSocket handshake requests.
Parameters
- Rest ...args: RouteArguments
Returns Route
Example
```
// Route with destination
app.websocket('/echo').to('Example#echo');
```
Inherited from Route.websocket
- Defined in mojo.js-main/src/router/route.ts:296

Class Router

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Router

Properties

_lookupIndex

_parent

_root

cache

children

conditions

controllerPaths

controllers

customName

defaultName

methods

pattern

requirements

types

underRoute

websocketRoute

Accessors

parent

Returns undefined | Route

Parameters

parent: undefined | Route

Returns void

root

Returns undefined | Router

Parameters

root: undefined | Router

Returns void

Methods

_branch

Returns (Route | Router)[]

_getLookupIndex

Returns RouteIndex

_getPlan

Parameters

ctx: MojoContext

Returns Promise<null | Plan>

_walk

Parameters

plan: Plan

route: Route

spec: RouteSpec

Returns Promise<boolean>

addChild

Parameters

child: Route

Returns Route

addCondition

Parameters

name: string

fn: RouteCondition

Returns Router

addType

Parameters

name: string

value: PlaceholderType

Returns Router

any

Parameters

Rest ...args: AnyArguments

Returns Route

Example

delete

Parameters

Rest ...args: RouteArguments

Returns Route

Example

dispatch

Parameters

ctx: MojoContext

`Rest` ...args: AnyArguments

`Rest` ...args: RouteArguments

`Rest` ...args: RouteArguments

`Rest` ...args: RouteArguments

`Rest` ...args: RouteArguments

`Rest` ...args: RouteArguments

`Rest` ...args: RouteArguments

`Rest` ...targets: (string | Record<string, any> | MojoAction)[]

`Rest` ...args: AnyArguments