Cloudflare Deploy | Package file

Version 49f948fa.bb1 · Apache-2.0. This preview displays packaged text and does not execute code. Treat the contents as untrusted instructions.

Cloudflare Pages Functions

Serverless functions on Cloudflare Pages using Workers runtime. Full-stack dev with file-based routing.

Need to... | Task | Go to | |------|-------| | Set up TypeScript types | configuration.md - TypeScript Setup | | Configure bindings (KV, D1, R2) | configuration.md - wrangler.jsonc | | Access request/env/params | api.md - EventContext | | Add middleware or auth | patterns.md - Middleware, Auth | | Background tasks (waitUntil) | patterns.md - Background Tasks | | Debug errors or check limits | gotchas.md - Common Errors, Limits |

Decision Tree: Is This Pages Functions?

Need serverless backend? 
├─ Yes, for a static site → Pages Functions
├─ Yes, standalone API → Workers
└─ Just static hosting → Pages (no functions)

Have existing Worker?
├─ Complex routing logic → Use _worker.js (Advanced Mode)
└─ Simple routes → Migrate to /functions (File-Based)

Framework-based?
├─ Next.js/SvelteKit/Remix → Uses _worker.js automatically
└─ Vanilla/HTML/React SPA → Use /functions

File-Based Routing

/functions
  ├── index.js              → /
  ├── api.js                → /api
  ├── users/
  │   ├── index.js          → /users/
  │   ├── [user].js         → /users/:user
  │   └── [[catchall]].js   → /users/*
  └── _middleware.js        → runs on all routes

Rules: - index.js → directory root - Trailing slash optional - Specific routes precede catch-alls - Falls back to static if no match

Dynamic Routes

Single segment [param] → string:

// /functions/users/[user].js
export function onRequest(context) {
  return new Response(`Hello ${context.params.user}`);
}
// Matches: /users/nevi

Multi-segment [[param]] → array:

// /functions/users/[[catchall]].js
export function onRequest(context) {
  return new Response(JSON.stringify(context.params.catchall));
}
// Matches: /users/nevi/foobar → ["nevi", "foobar"]

Key Features

Method handlers: onRequestGet, onRequestPost, etc.
Middleware: _middleware.js for cross-cutting concerns
Bindings: KV, D1, R2, Durable Objects, Workers AI, Service bindings
TypeScript: Full type support via wrangler types command
Advanced mode: Use _worker.js for custom routing logic

Reading Order

New to Pages Functions? Start here: 1. README.md - Overview, routing, decision tree (you are here) 2. configuration.md - TypeScript setup, wrangler.jsonc, bindings 3. api.md - EventContext, handlers, bindings reference 4. patterns.md - Middleware, auth, CORS, rate limiting, caching 5. gotchas.md - Common errors, debugging, limits

Quick reference lookup: - Bindings table → api.md - Error diagnosis → gotchas.md - TypeScript setup → configuration.md

openai-cloudflare-deploy/references/pages-functions/README.md