MIGRATION.md

Migration Guide

From v2.x.x to v3.x.x.

Contents

• Update Router
• Handlers

Update Router

Update to the latest version version of the router.

npm i -D @tsndr/cloudflare-worker-router@^3

Handlers

• Remove res and next from handler parameter list.
• Replace res. with return new Response() / return Response.json().
• Remove next() calls from middlewares.

Before

// Register global middleware
router.use(({ env, req, res, next }) => {
    if (req.headers.get('authorization') !== env.SECRET_TOKEN) {
        res.status = 401
        return
    }

    next()
})

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

After

// 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'
    })
})