Middleware

Module Overview

Middleware are instances of the RequestRouter, each with single responsibility e.g. (users, blog posts, payments, authentication, etc.)

import { UsersRouter } from '@local/worker/routers/UsersRouter'
import { BlogRouter } from '@local/worker/routers/BlogRouter'
import { AuthenticationRouter } from '@local/worker/routers/AuthenticationRouter'
import { CloudflarePagesAssetRouter } from 'keywork/assets'
import { RequestRouter } from 'keywork/router'

// Create a router to receive all incoming requests...
const app = new RequestRouter({
  // Here we combine our routers...
  middleware: [
    AuthenticationRouter,
    UsersRouter,
    BlogRouter,
    // And serve static assets...
    new CloudflarePagesAssetRouter(),
  ],
})

Middleware routers can perform any task that of single router such as...

• Executing any code
• Make changes to the request and the response of another router
• Terminate a request
• Intercept a request to check for authentication
• Call the next route handler in the stack

Built-in Middleware

Keywork includes a number of built-in middleware for common use cases:

• Automatic response compression
• Basic session management
• Cross-Origin Resource Sharing (CORS)
• Cloudflare
  • Serve static assets from Cloudflare Pages
  • Serve static assets from a Worker Site
  • Proxy requests directly to another Cloudflare Worker

Usage

Node

import * as Middleware from 'keywork/middleware'

Deno

import * as Middleware from 'https://deno.land/x/keywork/middleware'

Browser/ESM

let Middleware = await import('https://esm.sh/keywork/middleware')

Asset Router Classes

• WorkerSitesAssetRouter

Cloudflare Middleware Classes

• CloudflarePagesAssetRouter
• ServiceBindingRouter

Other Classes

• CORSMiddleware
• CompressionMiddleware
• SessionMiddleware

Cloudflare Middleware Interfaces

• WorkersSiteStaticContentBinding

Other Interfaces

• SessionMiddlewareOptions

Request Interfaces

• IsomorphicFetchEventData

Session Management Interfaces

• KeyworkSession