Routes Configuration

Configure the Deserve routes directory to match the project structure. Every option lives on the RouterOptions object passed to new Router(...).

Router Options

The Router constructor accepts one options object. The everyday pair is routes.directory for the route folder and timeoutMs for a request deadline. The sections below cover route loading, request size limits, template render limits, and the two advanced hooks trustProxy and worker. Two related options live on their own pages, trustProxy under Client IP Resolution and the worker pool under Worker Pool.

import { Router } from '@neabyte/deserve'

// Custom routes folder and timeout
const router = new Router({
  routes: {
    directory: './src/routes'
  },
  timeoutMs: 30_000
})

routes

routes.directory

The directory containing the route files. Defaults to ./routes:

// Defaults to ./routes
const defaultRouter = new Router()

// Read routes from ./src/api
const router = new Router({
  routes: {
    directory: './src/api'
  }
})

routes.maxParamLength

Maximum length of a single route parameter value. A longer value is rejected with 414 URI Too Long. The default is 1024:

const router = new Router({
  routes: {
    directory: './routes',
    maxParamLength: 512
  }
})

views

views.directory

The directory containing DVE template files. Defaults to ./views. When omitted, ctx.render() throws because no view engine is configured:

const router = new Router({
  routes: {
    directory: './routes'
  },
  views: {
    directory: './views'
  }
})

views.maxIterations

Maximum iterations allowed per {{#each}} block in DVE templates. The cap prevents event loop starvation from one unbounded loop. The default is 100_000, and exceeding it makes the engine throw so the server responds with 400 Bad Request.

const router = new Router({
  routes: {
    directory: './routes'
  },
  views: {
    directory: './views',
    maxIterations: 50_000
  }
})

For datasets larger than the limit, use ctx.render with stream: true instead, and see Performance and Limits for how the cap behaves. For CPU-intensive rendering, consider offloading to a worker pool.

views.maxRenderIterations

Maximum total {{#each}} body executions across one render, summed over every loop including nested ones. Where maxIterations guards a single loop, this guards the whole page. The default is 1_000_000, and exceeding it responds with 400 Bad Request.

const router = new Router({
  routes: {
    directory: './routes'
  },
  views: {
    directory: './views',
    maxRenderIterations: 500_000
  }
})

views.maxOutputSize

Maximum total output characters produced by one render. The cap stops a small template from expanding into a huge response. The default is 5_000_000, and exceeding it responds with 400 Bad Request.

const router = new Router({
  routes: {
    directory: './routes'
  },
  views: {
    directory: './views',
    maxOutputSize: 1_000_000
  }
})

views.maxTemplateSize

Maximum size of a single template file in characters. The cap stops an oversized template from consuming memory before it ever compiles. The default is 1_000_000, set by the DVE engine, and exceeding it responds with 400 Bad Request. The same cap applies to every included or layout file the engine resolves.

const router = new Router({
  routes: {
    directory: './routes'
  },
  views: {
    directory: './views',
    maxTemplateSize: 500_000
  }
})

maxUrlLength

Maximum length of the request URL in characters. A longer URL is rejected with 414 URI Too Long before any route runs. The default is 8192:

const router = new Router({
  maxUrlLength: 4096
})

timeoutMs

Optional timeout in milliseconds for the full request (middleware + route handler). If exceeded, the server responds with 503 Service Unavailable. Omit or leave undefined for no timeout. See also Server Configuration:

const router = new Router({
  routes: {
    directory: './routes'
  },
  timeoutMs: 30_000
})

hotReload

Enables or disables file watching for routes and views. Defaults to true. Set to false to disable hot reload entirely, which suits production deployments where file watching is unnecessary:

const router = new Router({
  hotReload: false
})

trustProxy

Controls how the real client IP is resolved behind a proxy or load balancer. See Client IP Resolution for the full guide.

worker

Configures a worker pool for offloading CPU-bound work. See Worker Pool for the full guide.

Supported File Extensions

Deserve automatically detects and supports these file extensions:

• .ts (TypeScript)
• .js (JavaScript)
• .tsx (TypeScript with JSX)
• .jsx (JavaScript with JSX)
• .mjs (ES Modules)
• .cjs (CommonJS)

No extra configuration is needed, since Deserve detects them automatically.

Absolute vs Relative Paths

Relative Paths

const router = new Router({
  routes: {
    directory: './routes'
  }
})

Absolute Paths

const router = new Router({
  routes: {
    directory: `${Deno.cwd()}/routes`
  }
})

const router = new Router({
  routes: {
    directory: '/absolute/path/to/routes'
  }
})