Cloudflare Worker Router

To use the router, import Router, initialize it with your environment, context, and request extensions, and then call router.handle within your Cloudflare Worker's fetch event listener. You can register global middleware using router.use() and define routes for various HTTP methods.

import { Router } from '@tsndr/cloudflare-worker-router'

export type Env = { ENVIRONMENT: string; SECRET_TOKEN: string }
export type ExtReq = { userId?: number }
export type ExtCtx = {}

const router = new Router<Env, ExtCtx, ExtReq>()

// Global middleware
router.use(({ env, req }) => {
    if (req.headers.get('authorization') !== env.SECRET_TOKEN)
        return new Response(null, { status: 401 })
})

// Route with URL parameter
router.post('/user/:id', ({ req }) => {
    const userId = req.params.id
    return Response.json({ userId }, { status: 204 })
})

export default {
    async fetch(request: Request, env: Env, ctx: ExecutionContext) {
        return router.handle(request, env, ctx)
    }
}

import { Router } from '@tsndr/cloudflare-worker-router'

// Env Types
export type Var<T = string> = T
export type Secret<T = string> = T

export type Env = {
    ENVIRONMENT: Var<'dev' | 'prod'>
    SECRET_TOKEN: Secret
}

// Request Extension
export type ExtReq = {
    userId?: number
}

// Context Extension
export type ExtCtx = {}

// Initialize Router
const router = new Router<Env, ExtCtx, ExtReq>()

// Enabling build in CORS support
router.cors()

// Register global middleware
router.use(({ env, req }) => {
    // Intercept if token doesn't match
    if (req.headers.get('authorization') !== env.SECRET_TOKEN)
        return new Response(null, { status: 401 })
})

// Simple get
router.get('/user', () => {
    return Response.json({
        id: 1,
        name: 'John Doe'
    })
})

// Post route with url parameter
router.post('/user/:id', ({ req }) => {

    const userId = req.params.id

    // Do stuff

    if (!true) {
        return Response.json({
            error: 'Error doing stuff!'
        }, { status: 400 })
    }

    return Response.json({ userId }, { status: 204 })
})

// Delete route using a middleware
router.delete('/user/:id', ({ env, req }) => {
    if (req.headers.get('authorization') === env.SECRET_TOKEN)
        return new Response(null, { status: 401 })

}, ({ req }) => {

  const userId = req.params.id

  // Do stuff...

  return Response.json({ userId })
})

// Listen Cloudflare Workers Fetch Event
export default {
    async fetch(request: Request, env: Env, ctx: ExecutionContext) {
        return router.handle(request, env, ctx)
    }
}

In v3.x.x, the handler signature has changed. Follow these steps to refactor your code:

1. Update Parameters: Remove res and next from the destructuring pattern in your handler arguments.
2. Replace res. mutations: Instead of setting res.status or res.body, use return new Response(body, { status }) or return Response.json(body).
3. Remove next(): Middlewares no longer use next() to pass control. To allow the request to continue, simply return nothing (or do not return a Response). To intercept/stop the request, return a Response object.

// Register global middleware
router.use(({ env, req }) => {
    // Intercept if token doesn't match
    if (req.headers.get('authorization') !== env.SECRET_TOKEN) {
        return new Response(null, { status: 401 })
    }
})

// Simple get
router.get('/user', () => {
    return Response.json({
        id: 1,
        name: 'John Doe'
    })
})