-
-
Notifications
You must be signed in to change notification settings - Fork 789
docs(cloudflare): fix env bindings access pattern for Nitro v3 (breaking change) #4064
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.
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
ruan-cat
wants to merge
2
commits into
nitrojs:main
Choose a base branch
from
ruan-cat:fix-doc/cloudflare-env-v3
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+25
−4
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -290,14 +290,19 @@ For more details on Bindings and how to use them please refer to the Cloudflare | |
|
|
||
| :read-more{title="KV Storage" to="/docs/storage"} | ||
|
|
||
| In runtime, you can access bindings from the request event, by accessing its `context.cloudflare.env` field, this is for example how you can access a D1 bindings: | ||
| In runtime, you can access bindings from the request event via `event.req.runtime.cloudflare.env`. This is for example how you can access a D1 binding: | ||
|
|
||
| ::warning | ||
| **Nitro v3 Breaking Change:** The `event.context.cloudflare.env` pattern from Nitro v2 no longer works in production. Use `event.req.runtime.cloudflare.env` instead. The old pattern may still appear to work in local dev (via the Wrangler proxy plugin) but will be `undefined` in production deployments. | ||
| :: | ||
|
|
||
| ```ts | ||
| import { defineHandler } from "nitro/h3"; | ||
|
|
||
| defineHandler(async (event) => { | ||
| const { cloudflare } = event.context | ||
| const stmt = await cloudflare.env.MY_D1.prepare('SELECT id FROM table') | ||
| // Nitro v3: access Cloudflare bindings via event.req.runtime.cloudflare.env | ||
ruan-cat marked this conversation as resolved.
Show resolved
Hide resolved
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think we need the v3 code comment since these docs are for v3 rather than the migration guide. |
||
| const { env } = event.req.runtime.cloudflare | ||
| const stmt = await env.MY_D1.prepare('SELECT id FROM table') | ||
| const { results } = await stmt.all() | ||
| }) | ||
| ``` | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here — with the dev plugin fix, the local dev caveat no longer applies. Can simplify to: