Skip to main content

Function: routeAgentRequest()

routeAgentRequest(request, env, options): Promise<undefined | Response>

Defined in: packages/utils/src/index.ts:38

Convenience wrapper for routeDORequest with agentCompatibility: true.

A drop-in replacement for Cloudflare's routeAgentRequest from the agents package. Automatically adds required headers (x-partykit-namespace, x-partykit-room) and defaults to prefix: 'agents' for routing Agent DOs.

Parameters​

request​

Request

The incoming HTTP request to route

env​

any

Environment object containing DO bindings

options​

Omit<RouteOptions, "agentCompatibility"> = {}

Configuration options (agentCompatibility is set to true)

Returns​

Promise<undefined | Response>

Promise resolving to Response if request was handled, undefined if not matched

Example​

export default {
  async fetch(request, env) {
    return (
      await routeAgentRequest(request, env) ||
      new Response("Not Found", { status: 404 })
    );
  }
}