Skip to content

docs: update docs for OpenAPI Type Gen support in Cloudflare Workers #766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sillyvan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update docs for OpenAPI Type Gen support in Cloudflare Workers #766

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/integrations/cloudflare-worker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ wrangler dev

This should start a development server at `http://localhost:8787`

You don't need a `nodejs_compat` flag as Elysia doesn't use any Node.js built-in modules (or the ones we use don't support Cloudflare Worker yet).
You don't need a `nodejs_compat` flag for basic usage. However, if you want to use [OpenAPI Type Gen](/blog/openapi-type-gen), you'll need to enable it with compatibility_date 2025-09-01 or later.

### pnpm
If you use pnpm, [pnpm doesn't auto install peer dependencies by default](https://github.com/orgs/pnpm/discussions/3995#discussioncomment-1893230) forcing you to install additional dependencies manually.
Expand All @@ -76,8 +76,8 @@ pnpm add @sinclair/typebox openapi-types
## Limitations
Here are some known limitations of using Elysia on Cloudflare Worker:

1. `Elysia.file`, and [Static Plugin](/plugins/static) doesn't work [due to the lack of `fs` module](https://developers.cloudflare.com/workers/runtime-apis/nodejs/#supported-nodejs-apis), see [static file](#static-file) section for alternative
2. [OpenAPI Type Gen](/blog/openapi-type-gen) doesn't work [due to the lack of `fs` module](https://developers.cloudflare.com/workers/runtime-apis/nodejs/#supported-nodejs-apis)
1. `Elysia.file`, and [Static Plugin](/plugins/static) doesn't work, see [static file](#static-file) section for Cloudflare's built-in alternative
2. [OpenAPI Type Gen](/blog/openapi-type-gen) requires `nodejs_compat` flag enabled in wrangler config (compatibility_date 2025-09-01 or later)
3. You can't define [**Response** before server start](https://x.com/saltyAom/status/1966602691754553832) or use plugin that does so
4. You can't inline a value due to 3.

Expand Down