Class Route

constructor

• new Route(): Route

• Returns Route

_parent

_root

children

customName

defaultName

methods

pattern

requirements

underRoute

websocketRoute

parent

• get parent(): undefined | Route

• The parent of this route.

  Returns undefined | Route
• set parent(parent): void

• Parameters

  • parent: undefined | Route

  Returns void

root

• get root(): undefined | Router

• Return the Router object this route is a descendant of.

  Returns undefined | Router
• set root(root): void

• Parameters

  • root: undefined | Router

  Returns void

_branch

• _branch(): (Route | Router)[]

• Returns (Route | Router)[]

addChild

• addChild(child): Route

• Add a child to this route.

  Parameters

  • child: Route

  Returns Route

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!'}));
  Copy

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');
  Copy

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');
  Copy

hasWebSocket

• hasWebSocket(): boolean

• Check if this route has a WebSocket ancestor and cache the result for future checks.

  Returns boolean

isEndpoint

• isEndpoint(): boolean

• Check if this route qualifies as an endpoint.

  Returns boolean

name

• name(name): Route

• 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 Route

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');
  Copy

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');
  Copy

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');
  Copy

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');
  Copy

remove

• remove(): Route

• Remove route from parent.

  Returns Route

render

• render(values?): string

• Render route with parameters into a path.

  Parameters

  • values: {} = {}

  Returns string

requires

• requires(condition, requirement): Route

• 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 Route

suggestedMethod

• suggestedMethod(): string

• Suggested HTTP method for reaching this route, GET and POST are preferred.

  Returns string

to

• to(...targets): Route

• Set default parameters for this route.

  Parameters

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

  Returns Route

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');
  Copy

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');
  Copy