@whatwg-node/server
v0.10.18
Published
Fetch API compliant HTTP Server adapter
Readme
WHATWG Node Generic Server Adapter
@whatwg-node/server helps you to create a generic server implementation by using WHATWG Fetch API
for Node.js, AWS Lambda, Cloudflare Workers, Deno, Express, Fastify, Koa, Next.js and Sveltekit.
Once you create an adapter with createServerAdapter, you don't need to install any other platform
specific package since the generic adapter will handle it automatically.
How to start
Let's create a basic Hello World server adapter.
// myServerAdapter.ts
import { createServerAdapter } from '@whatwg-node/server'
export default createServerAdapter((request: Request) => {
return new Response(`Hello World!`, { status: 200 })
})Integrations
You can use your server adapter with the following integrations:
Node.js
Node.js is the most popular server side JavaScript runtime.
import { createServer } from 'http'
import myServerAdapter from './myServerAdapter'
// You can create your Node server instance by using our adapter
const nodeServer = createServer(myServerAdapter)
// Then start listening on some port
nodeServer.listen(4000)AWS Lambda
AWS Lambda is a serverless computing platform that makes it easy to build applications that run on the AWS cloud. Our adapter is platform agnostic so they can fit together easily. In order to reduce the boilerplate we prefer to use Serverless Express from Vendia.
import { Buffer } from 'node:buffer'
import { pipeline } from 'node:stream/promises'
import type { Context, LambdaFunctionURLEvent } from 'aws-lambda'
import myServerAdapter from './myServerAdapter'
interface ServerContext {
event: LambdaFunctionURLEvent
lambdaContext: Context
res: awslambda.ResponseStream
}
export const handler = awslambda.streamifyResponse(async function handler(
event: LambdaFunctionURLEvent,
res,
lambdaContext
) {
const response = await myServerAdapter.fetch(
// Construct the URL
`https://${event.requestContext.domainName}${event.requestContext.http.path}?${event.rawQueryString}`,
{
method: event.requestContext.http.method,
headers: event.headers as HeadersInit,
// Parse the body if needed
body:
event.body && event.isBase64Encoded ? Buffer.from(event.body, 'base64') : event.body || null
},
{
event,
res,
lambdaContext
}
)
// Attach the metadata to the response stream
res = awslambda.HttpResponseStream.from(res, {
statusCode: response.status,
headers: Object.fromEntries(response.headers.entries())
})
if (response.body) {
// @ts-expect-error - Pipe the response body to the response stream
await pipeline(response.body, res)
}
// End the response stream
res.end()
})If you have missing types for awslambda, you can add awslambda.d.ts like following;
// awslambda.d.ts
import type { Writable } from 'node:stream'
import type { Context, Handler } from 'aws-lambda'
declare global {
namespace awslambda {
export namespace HttpResponseStream {
function from(
responseStream: ResponseStream,
metadata: {
statusCode?: number
headers?: Record<string, string>
}
): ResponseStream
}
export type ResponseStream = Writable & {
setContentType(type: string): void
}
export type StreamifyHandler<Event> = (
event: Event,
responseStream: ResponseStream,
context: Context
) => Promise<unknown>
export function streamifyResponse<Event>(handler: StreamifyHandler<Event>): Handler<Event>
}
}Cloudflare Workers
Cloudflare Workers provides a serverless execution environment that allows you to create entirely new applications or augment existing ones without configuring or maintaining infrastructure. It uses Fetch API already so we can use our adapter as an event listener like below;
import myServerAdapter from './myServerAdapter'
self.addEventListener('fetch', myServerAdapter)Deno
Deno is a simple, modern and secure runtime for JavaScript and TypeScript that uses V8 and is built in Rust. You can use our adapter as a Deno request handler like below;
import myServerAdapter from './myServerAdapter.ts'
Deno.serve(myServerAdapter)Express
Express is the most popular web framework for Node.js. It is a minimalist framework that provides a robust set of features to handle HTTP on Node.js applications.
You can easily integrate your adapter into your Express application with a few lines of code.
import express from 'express'
import myServerAdapter from './myServerAdapter'
const app = express()
// Bind our adapter to `/mypath` endpoint
app.use('/mypath', myServerAdapter)
app.listen(4000, () => {
console.log('Running the server at http://localhost:4000/mypath')
})Fastify
Fastify is one of the popular HTTP server frameworks for Node.js.. You can use your adapter easily with Fastify.
So you can benefit from the powerful plugins of Fastify ecosystem. See the ecosystem
import fastify, { FastifyReply, FastifyRequest } from 'fastify'
import myServerAdapter from './myServerAdapter'
// This is the fastify instance you have created
const app = fastify({ logger: true })
/**
* We pass the incoming HTTP request to our adapter
* and handle the response using Fastify's `reply` API
* Learn more about `reply` https://www.fastify.io/docs/latest/Reply/
**/
app.route({
url: '/mypath',
method: ['GET', 'POST', 'OPTIONS'],
handler: (req, reply) =>
myServerAdapter.handleNodeRequestAndResponse(req, reply, {
req,
reply
})
})
app.listen(4000)Koa
Koa is another Node.js server framework designed by the team behind Express, which aims to be a smaller, more expressive. You can add your adapter to your Koa application with a few lines of code then benefit middlewares written for Koa.
import Koa from 'koa'
import myServerAdapter from './myServerAdapter'
const app = new Koa()
app.use(async ctx => {
const response = await myServerAdapter.handleNodeRequestAndResponse(ctx.request, ctx.res, ctx)
// Set status code
ctx.status = response.status
// Set headers
response.headers.forEach((value, key) => {
ctx.append(key, value)
})
ctx.body = response.body
})
app.listen(4000, () => {
console.log('Running the server at http://localhost:4000')
})Next.js
Next.js is a web framework that allows you to build websites very quickly and our new server adapter can be integrated with Next.js easily as an API Route.
// pages/api/myEndpoint.ts
// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
import type { NextApiRequest, NextApiResponse } from 'next'
import myServerAdapter from './myServerAdapter'
export const config = {
api: {
// Disable body parsing if you expect a request other than JSON
bodyParser: false
}
}
export default myServerAdapterSvelteKit
SvelteKit is the fastest way to build svelte apps. It is very simple, and let you build frontend & backend in a single place
import myServerAdapter from './myServerAdapter'
export { myServerAdapter as get, myServerAdapter as post }Bun
Bun is a modern JavaScript runtime like Node or Deno, and it supports Fetch API as a first class citizen. So the configuration is really simple like any other JS runtime;
import myServerAdapter from './myServerAdapter'
const server = Bun.serve(myServerAdapter)
console.info(`Server is running on ${server.hostname}`)File Uploads / Multipart Requests
Multipart requests are a type of HTTP request that allows you to send blobs together with regular
text data which has a mime-type multipart/form-data.
For example, if you send a multipart request from a browser with FormData, you can get the same
FormData object in your request handler.
import { createServerAdapter } from '@whatwg-node/server'
const myServerAdapter = createServerAdapter(async request => {
// Parse the request as `FormData`
const formData = await request.formData()
// Select the file
const file = formData.get('file')
// Process it as a string
const fileTextContent = await file.text()
// Select the other text parameter
const regularTextData = formData.get('additionalStuff')
// ...
return Response.json({ message: 'ok' })
})You can learn more about File API on MDN documentation.
Routing and Middlewares
We'd recommend to use fets to handle routing and middleware approach. It uses
@whatwg-node/server under the hood.
Learn more about
fetshere
Plugin System
You can create your own plugins to extend the functionality of your server adapter.
onRequest
This hook is invoked for ANY incoming HTTP request. Here you can manipulate the request or create a short circuit before the server adapter handles the request.
For example, you can shortcut the manually handle an HTTP request, short-circuiting the HTTP handler:
import { createServerAdapter, type ServerAdapterPlugin } from '@whatwg-node/server'
const myPlugin: ServerAdapterPlugin = {
onRequest({ request, endResponse, fetchAPI }) {
if (!request.headers.get('authorization')) {
endResponse(
new fetchAPI.Response(null, {
status: 401,
headers: {
'Content-Type': 'application/json'
}
})
)
}
}
}
const myServerAdapter = createServerAdapter(
async request => {
return new Response(`Hello World!`, { status: 200 })
},
{
plugins: [myPlugin]
}
)Possible usage examples of this hook are:
- Manipulate the request
- Short circuit before the adapter handles the request
| Payload field | Description |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| request | The incoming HTTP request as WHATWG Request object. Learn more about the request. |
| serverContext | The early context object that is shared between all hooks and the entire execution. Learn more about the context. |
| fetchAPI | WHATWG Fetch API implementation. Learn more about the fetch API. |
| url | WHATWG URL object of the incoming request. Learn more about the URL object. |
| endResponse | A function that allows you to end the request early and send a response to the client. |
onResponse
This hook is invoked after a HTTP request has been processed and after the response has been forwarded to the client. Here you can perform any cleanup or logging operations, or you can manipulate the outgoing response object.
import { createServerAdapter, type ServerAdapterPlugin } from '@whatwg-node/server'
const requestTimeMap = new WeakMap<Request, number>()
const myPlugin: ServerAdapterPlugin = {
onRequest({ request }) {
requestTimeMap.set(request, Date.now())
},
onResponse({ request, serverContext, response }) {
console.log(`Request to ${request.url} has been processed with status ${response.status}`)
// Add some headers
response.headers.set('X-Server-Name', 'My Server')
console.log(`Request to ${request.url} took ${Date.now() - requestTimeMap.get(request)}ms`)
}
}Example actions in this hook:
- Specify custom response format
- Logging/Metrics
| Field Name | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| request | The incoming HTTP request as WHATWG Request object. Learn more about the request. |
| serverContext | The final context object that is shared between all hooks and the execution. Learn more about the context. |
| response | The outgoing HTTP response as WHATWG Response object. Learn more about the response interface. |
onDispose
In order to clean up resources when the server is shut down, you can use onDispose,
Symbol.asyncDispose or Symbol.syncDispose to clean up resources.
export const useMyPlugin = () => {
return {
async onDispose() {
// Clean up resources
await stopConnection()
}
}
}You can learn more about Explicit Resource Management below
Request.signal for awareness of client disconnection
In the real world, a lot of HTTP requests are dropped or canceled. This can happen due to a flakey internet connection, navigation to a new view or page within a web or native app or the user simply closing the app. In this case, the server can stop processing the request and save resources.
You can utilize request.signal to cancel pending asynchronous operations when the client
disconnects.
import { createServerAdapter } from '@whatwg-node/server'
const myServerAdapter = createServerAdapter(async request => {
const upstreamRes = await fetch('https://api.example.com/data', {
// When the client disconnects, the fetch request will be canceled
signal: request.signal
})
return Response.json({
data: await upstreamRes.json()
})
})The execution cancelation API is built on top of the AbortController and AbortSignal APIs.
Learn more about AbortController and AbortSignal
Explicit Resource Management
While implementing your server with @whatwg-node/server, you need to control over the lifecycle of
your resources. This is especially important when you are dealing with resources that need to be
cleaned up when they are no longer needed, or clean up the operations in a queue when the server is
shutting down.
Dispose the Server Adapter
The server adapter supports Explicit Resource Management approach that allows you to dispose of resources when they are no longer needed. This can be done in two ways shown below;
await using syntax
We use the await using syntax to create a new instance of adapter and dispose of it when the
block is exited. Notice that we are using a block to limit the scope of adapter within { }. So
resources will be disposed of when the block is exited.
console.log('Adapter is starting')
{
await using adapter = createServerAdapter(/* ... */)
}
console.log('Adapter is disposed')dispose method
We create a new instance of adapter and dispose of it using the dispose method.
console.log('Adapter is starting')
const adapter = createServerAdapter(/* ... */)
await adapter.dispose()
console.log('Adapter is disposed')In the first example, we use the await using syntax to create a new instance of adapter and
dispose of it when the block is exited. In the second example,
Dispose on Node.js
When running your adapter on Node.js, you can use process event listeners or server's close event
to trigger the adapter's disposal. Or you can configure the adapter to handle this automatically by
listening process exit signals.
Explicit disposal
We can dispose of the adapter instance when the server is closed like below.
import { createServer } from 'http'
import { createServerAdapter } from '@whatwg-node/server'
const adapter = createServerAdapter(/* ... */)
const server = createServer(adapter)
server.listen(4000, () => {
console.info('Server is running on http://localhost:4000')
})
server.once('close', async () => {
await adapter.dispose()
console.info('Server is disposed so is adapter')
})Automatic disposal
disposeOnProcessTerminate option will register an event listener for process termination in
Node.js
import { createServer } from 'http'
import { createServerAdapter } from '@whatwg-node/server'
createServer(
createServerAdapter(/* ... */, {
disposeOnProcessTerminate: true,
plugins: [/* ... */]
})
).listen(4000, () => {
console.info('Server is running on http://localhost:4000')
})Plugin Disposal
If you have plugins that need some internal resources to be disposed of, you can use the onDispose
hook to dispose of them. This hook will be invoked when the adapter instance is disposed like above.
let dbConnection: Connection
const plugin = {
onPluginInit: async () => {
dbConnection = await createConnection()
},
onDispose: async () => {
// Dispose of resources
await dbConnection.close()
}
}Or you can flush a queue of operations when the server is shutting down.
const backgroundJobs: Promise<void>[] = []
const plugin = {
onRequest() {
backgroundJobs.push(
sendAnalytics({
/* ... */
})
)
},
onDispose: async () => {
// Flush the queue of background jobs
await Promise.all(backgroundJobs)
}
}But for this kind of purposes, waitUntil can be a better choice.
Background jobs
If you have background jobs that need to be completed before the environment is shut down.
waitUntil is better choice than onDispose. In this case, those jobs will keep running in the
background but in case of disposal, they will be awaited. waitUntil works so similar to
Cloudflare Workers' waitUntil function.
But the adapter handles waitUntil even if it is not provided by the environment.
const adapter = createServerAdapter(async (request, context) => {
const args = await request.json()
if (!args.name) {
return Response.json({ error: 'Name is required' }, { status: 400 })
}
// This does not block the response
context.waitUntil(
fetch('http://my-analytics.com/analytics', {
method: 'POST',
body: JSON.stringify({
name: args.name,
userAgent: request.headers.get('User-Agent')
})
})
)
return Response.json({ greetings: `Hello, ${args.name}` })
})
const res = await adapter.fetch('http://localhost:4000', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({ name: 'John' })
})
console.log(await res.json()) // { greetings: "Hello, John" }
await adapter.dispose()
// The fetch request for `analytics` will be awaited hereAPI Reference
createServerAdapter(handler, options?)
Creates a server adapter that can handle HTTP requests across different platforms.
Parameters:
handler: (request: Request, context: TServerContext) => MaybePromise<Response>- The main request handler function that receives a WHATWGRequestobject and returns aResponse.options?: ServerAdapterOptions- Optional configuration object with the following properties:plugins?: ServerAdapterPlugin[]- Array of plugins to extend adapter functionalityfetchAPI?: Partial<FetchAPI>- Custom Fetch API implementation (defaults to@whatwg-node/fetch)disposeOnProcessTerminate?: boolean- (Node.js only) Iftrue, automatically dispose the adapter when the process terminates
Returns: ServerAdapter - An adapter instance with the following methods and properties:
Adapter Methods
fetch(input, init?, context?)
WHATWG Fetch spec compliant method for handling requests.
const response = await adapter.fetch('http://localhost:4000/api', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ data: 'value' })
})Signatures:
fetch(request: Request, ...ctx: Partial<TServerContext>[]): MaybePromise<Response>fetch(url: string | URL, init?: RequestInit, ...ctx: Partial<TServerContext>[]): MaybePromise<Response>
handleRequest(request, context)
Basic request listener that takes a Request and server context.
const response = await adapter.handleRequest(request, serverContext)handleNodeRequest(nodeRequest, ...context) (Deprecated)
Converts a Node.js IncomingMessage to a Request and returns a Response.
const response = await adapter.handleNodeRequest(req, { customContext: 'value' })Deprecated: Use handleNodeRequestAndResponse instead.
handleNodeRequestAndResponse(nodeRequest, nodeResponse, ...context)
Handles a Node.js request/response pair and returns a WHATWG Response object.
⚠️ Important: This method returns a Response object but does not automatically write it to
the Node.js response object. You need to manually send the response or use requestListener()
instead for automatic response handling.
// Returns a Response but doesn't write to `res`
const response = await adapter.handleNodeRequestAndResponse(req, res, { customContext: 'value' })
// Use requestListener or adapter(req, res) instead for automatic handlingUse case: This method is useful when you need access to the WHATWG Response object for
inspection or further processing before sending it.
requestListener(nodeRequest, nodeResponse, ...context)
A Node.js-compatible request listener that can be used with http.createServer() or similar.
import { createServer } from 'http'
const server = createServer(adapter.requestListener)handleEvent(fetchEvent, ...context)
Handles a FetchEvent (used in Cloudflare Workers, Service Workers, etc.).
self.addEventListener('fetch', adapter.handleEvent)handleUWS(uwsResponse, uwsRequest, ...context)
Handles requests from uWebSockets.js.
app.any('/*', adapter.handleUWS)handle(input, ...context)
Generic handler that automatically detects the input type and routes to the appropriate handler. Supports:
- Node.js
IncomingMessage+ServerResponse - WHATWG
Request FetchEvent- uWebSockets.js request/response
- Request containers (
{ request: Request })
dispose()
Disposes the adapter and cleans up all resources. Returns a Promise<void>.
await adapter.dispose()waitUntil(promise)
Registers a promise to be awaited before the adapter is disposed. Useful for background tasks.
adapter.waitUntil(logAnalytics(request).catch(err => console.error('Analytics failed:', err)))Adapter Properties
disposableStack
Returns the internal AsyncDisposableStack for advanced resource management.
Special Behaviors
The adapter also works as:
- Function: Can be called directly as a generic handler. When called with Node.js
request/response objects like
adapter(req, res, ...context), it's equivalent to callingadapter.handle(req, res, ...context)which internally routes torequestListener(). Additional context objects can be passed as spread arguments. - Event Listener: Can be used with
addEventListener('fetch', adapter) - AsyncDisposable: Supports
await using adapter = createServerAdapter(...)
Direct call examples:
// Node.js - equivalent to requestListener
adapter(nodeReq, nodeRes)
adapter(nodeReq, nodeRes, { customContext: 'value' })
// WHATWG Request - equivalent to fetch
adapter(request)
adapter(request, { customContext: 'value' })
// FetchEvent - equivalent to handleEvent
adapter(fetchEvent)
// uWebSockets.js - equivalent to handleUWS
adapter(uwsRes, uwsReq)Built-in Plugins
useCORS(options?)
Adds CORS (Cross-Origin Resource Sharing) support to your server.
Parameters:
options?: CORSPluginOptions- Can be:boolean-trueenables CORS with defaults,falsedisables itCORSOptionsobject:origin?: string | string[]- Allowed origins ('*'allows all)methods?: string[]- Allowed HTTP methodsallowedHeaders?: string[]- Allowed request headersexposedHeaders?: string[]- Headers exposed to the clientcredentials?: boolean- Allow credentialsmaxAge?: number- Preflight cache duration in seconds
(request: Request, context: TServerContext) => MaybePromise<CORSOptions>- Dynamic CORS options factory
Example:
import { createServerAdapter, useCORS } from '@whatwg-node/server'
const adapter = createServerAdapter(handler, {
plugins: [
useCORS({
origin: ['https://example.com', 'https://app.example.com'],
credentials: true,
methods: ['GET', 'POST', 'PUT', 'DELETE'],
allowedHeaders: ['Content-Type', 'Authorization'],
maxAge: 86400
})
]
})useErrorHandling(errorHandler?)
Adds error handling to your request handler.
Parameters:
errorHandler?: (error: any, request: Request, context: TServerContext) => MaybePromise<Response> | void- Custom error handler function
Default Behavior:
The default error handler checks for HTTPError instances or objects with status, headers, or
details properties and returns appropriate responses. Other errors are logged and return a 500
status.
HTTPError Class:
import { HTTPError } from '@whatwg-node/server'
throw new HTTPError(404, 'Resource not found', { 'X-Custom-Header': 'value' }, { id: 123 })Example:
import { createServerAdapter, useErrorHandling } from '@whatwg-node/server'
const adapter = createServerAdapter(handler, {
plugins: [
useErrorHandling((error, request, context) => {
console.error('Request failed:', error)
return new Response(JSON.stringify({ error: error.message }), {
status: error.status || 500,
headers: { 'Content-Type': 'application/json' }
})
})
]
})useContentEncoding()
Automatically handles request decompression and response compression based on Content-Encoding and
Accept-Encoding headers.
Supported encodings: gzip, deflate, br (Brotli), zstd, deflate-raw (depends on runtime
support)
Example:
import { createServerAdapter, useContentEncoding } from '@whatwg-node/server'
const adapter = createServerAdapter(handler, {
plugins: [useContentEncoding()]
})This plugin will:
- Decompress incoming request bodies based on
Content-Encodingheader - Compress outgoing response bodies based on
Accept-Encodingheader - Return
415 Unsupported Media Typefor unsupported encodings
Plugin System
Creating Custom Plugins
A plugin is an object implementing the ServerAdapterPlugin interface:
import { ServerAdapterPlugin } from '@whatwg-node/server'
const myPlugin: ServerAdapterPlugin = {
// Optional: Wrap the entire request handling pipeline
instrumentation?: {
request: ({ request }, wrapped) => {
console.log('Before request')
const result = wrapped()
console.log('After request')
return result
}
},
// Optional: Called for every incoming request
onRequest({ request, setRequest, serverContext, fetchAPI, url, requestHandler, setRequestHandler, endResponse }) {
// Modify the request
const newRequest = new fetchAPI.Request(request.url, {
...request,
headers: { ...request.headers, 'X-Custom-Header': 'value' }
})
setRequest(newRequest)
// Or short-circuit the request
if (!request.headers.get('authorization')) {
endResponse(new fetchAPI.Response('Unauthorized', { status: 401 }))
}
// Or replace the request handler
setRequestHandler(async (req, ctx) => {
// Custom handling logic
return requestHandler(req, ctx)
})
},
// Optional: Called after request is processed
onResponse({ request, response, setResponse, serverContext, fetchAPI }) {
// Modify the response
response.headers.set('X-Server', 'My Server')
// Or replace the response
setResponse(new fetchAPI.Response(response.body, {
...response,
headers: { ...response.headers, 'X-Custom': 'value' }
}))
},
// Optional: Called when adapter is disposed
onDispose: async () => {
// Clean up resources
await cleanup()
},
// Alternative disposal methods (Explicit Resource Management)
[Symbol.dispose]: () => { /* sync cleanup */ },
[Symbol.asyncDispose]: async () => { /* async cleanup */ }
}Plugin Hook Payloads
onRequest Payload
| Field | Type | Description |
| ------------------- | ------------------------------ | ------------------------------------- |
| request | Request | The incoming WHATWG Request object |
| setRequest | (request: Request) => void | Replace the request object |
| serverContext | TServerContext | The server context object |
| fetchAPI | FetchAPI | WHATWG Fetch API implementation |
| url | URL | Parsed URL of the request |
| requestHandler | Function | The current request handler |
| setRequestHandler | (handler: Function) => void | Replace the request handler |
| endResponse | (response: Response) => void | Short-circuit and end with a response |
onResponse Payload
| Field | Type | Description |
| --------------- | ------------------------------ | ----------------------------------- |
| request | Request | The incoming WHATWG Request object |
| response | Response | The outgoing WHATWG Response object |
| setResponse | (response: Response) => void | Replace the response object |
| serverContext | TServerContext | The server context object |
| fetchAPI | FetchAPI | WHATWG Fetch API implementation |
Types
ServerAdapterRequestHandler<TServerContext>
type ServerAdapterRequestHandler<TServerContext> = (
request: Request,
context: TServerContext & ServerAdapterInitialContext
) => MaybePromise<Response>ServerAdapterInitialContext
The base context object available to all request handlers:
type ServerAdapterInitialContext = {
waitUntil: (promise: Promise<void> | void) => void
}ServerAdapterNodeContext
Context object when using Node.js handlers:
type ServerAdapterNodeContext = {
req: IncomingMessage | Http2ServerRequest
res: ServerResponse | Http2ServerResponse
}FetchEvent
interface FetchEvent extends Event {
waitUntil(promise: MaybePromise<void>): void
request: Request
respondWith(response: MaybePromiseLike<Response>): void
}