Skip to content

add a section about local access in the Cloudflare bindings documentation #167

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
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

add a section about local access in the Cloudflare bindings documentation #167

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
46956f1
add a section about local access in the Cloudflare bindings documenta…
dario-piotrowicz Jun 26, 2025
be0dece
Update pages/cloudflare/bindings.mdx
dario-piotrowicz Jun 26, 2025
bf79523
Apply suggestions from code review
dario-piotrowicz Jun 26, 2025
3c3fc27
add callout with build example
dario-piotrowicz Jun 26, 2025
74a3c46
remove double enabled
dario-piotrowicz Jun 26, 2025
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
34 changes: 34 additions & 0 deletions pages/cloudflare/bindings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,40 @@ This will generate a `d.ts` file and save it to `worker-configuration.d.ts`.

To ensure that your types are always up-to-date, make sure to run `wrangler types --env-interface CloudflareEnv` after any changes to your config file.

## Local access to bindings
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: "Local access to bindgins" sounds confusing vs the following "Remote bindings"

Maybe

## Access to bindings

### Local bindings

### Remote bindings

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue is that this talks about remote bindings accessible locally, with the structure you're proposing, doesn't that make it sound like remote bindings accessible in your remote worker?


As presented in the [getting started](/cloudflare/get-started#12-develop-locally) your application can be both developed (`next dev`) and
previewed (`opennextjs-cloudflare preview`) locally, in both cases bindings will be accessible from your application's code.

Such bindings are by default local simulation that mimic the behavior of the actual Cloudflare resources.

### Remote bindings

As mentioned above, by default local emulations of the bindings are used.

However [remote bindings](https://developers.cloudflare.com/workers/development-testing/#remote-bindings) can also be
used, allowing your application code, while still running locally, to connect to remote resources associated to your
Cloudflare account.

Remote bindings are currently experimental and can be enabled it in your `next.config.ts` file:

```diff
- initOpenNextCloudflareForDev();
+ initOpenNextCloudflareForDev({
+ experimental: { remoteBindings: true }
+ });
```

When the feature is turned on all you then need to do to enable remote mode for any of your bindings
is to set the `experimental_remote` configuration field to `true`, exactly
as documented in the [remote bindings documentation](https://developers.cloudflare.com/workers/development-testing/#remote-bindings).

<Callout>
Note that remote bindings will also be used during build, this can be very useful for example when using
features such [ISR](https://nextjs.org/docs/app/guides/incremental-static-regeneration) so that read
production data can be used for the site's static generation
</Callout>

## Other Cloudflare APIs (`cf`, `ctx`)

You can access context about the incoming request from the [`cf` object](https://developers.cloudflare.com/workers/runtime-apis/request/#the-cf-property-requestinitcfproperties), as well as lifecycle methods from the [`ctx` object](https://developers.cloudflare.com/workers/runtime-apis/context) from the return value of [`getCloudflareContext()`](https://github.com/opennextjs/opennextjs-cloudflare/blob/main/packages/cloudflare/src/api/cloudflare-context.ts):
Expand Down