Routing Syntax

Inspired by well-known frameworks like Express, Toruk uses function chaining to register routes. This makes it easier to start working if you are familiar with it. Besides, it has it's downsides.

Object syntax

To improve code splitting, Toruk provides object routing syntax.

import { App } from 'https://deno.land/x/toruk/mod.ts'

new App({
  routes: [
    {
      path: '/',
      handler: () => new Response('Hello World!')
    }
  ]
}).serve()

While it's more complex, it provides a better separation of concerns:

import { App, Router, Handler } from 'https://deno.land/x/toruk/mod.ts'

// routes/index.ts
const handler: Handler = function () {
  return new Response('Hello World!')
}

// router.ts
const router = new Router({
  routes: [
    {
      path: '/',
      handler
    }
  ]
})

// app.ts
new App(router).serve()

💬 Info

This is the recommended syntax to write clean code and strongly typed APIs. We will be using it in the following examples.

Methods

By default, routes registered using object syntax are GET routes. This can be changed by using the method or methods properties.

{
  path: '/',
  method: 'POST',
  handler: () => new Response('Hello World!')
}

❗ Attention

If method and methods are both provided, the method property will take precedence.

Nesting

To be able to establish common paths between routes, you will need to relate different routes. This can be done using the children property.

// POST /user
// GET /user/:id
{
  path: '/user',
  method: 'POST',
  handler: () => new Response('User created!'),
  children: [
    {
      path: '/:id',
      handler: ({ params }) => Response.json({ id: params.id })
    }
  ]
}

When children is provided, handler is not required.

Child routes share parent's path and middlewares, as we will see in middlewares section.