Skip to content

Conversation

junitacademy
Copy link


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Sep 13, 2025

⚠️ No Changeset found

Latest commit: 27500f3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@svelte-docs-bot
Copy link

Preferences for the emulated `platform.env` local bindings. See the [getPlatformProxy](https://developers.cloudflare.com/workers/wrangler/api/#parameters-1) Wrangler API documentation for a full list of options.
Preferences for the emulated `platform.env` local bindings. See the [getPlatformProxy](https://developers.cloudflare.com/workers/wrangler/api/#parameters-1) Wrangler API documentation for a full list of options.

For local development, if you want to use cloudflare's local bindings like D1, KV etc., `platformProxy.environment` may be set, based on wrangler config env. For example if wrangler config has env, `main` for production build and `dev` or `staging` for non-production builds, `platformProxy.environment` can be set as `dev` or `staging`.
Copy link
Member

Choose a reason for hiding this comment

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

Cloudflare should be capitalized

Suggested change
For local development, if you want to use cloudflare's local bindings like D1, KV etc., `platformProxy.environment` may be set, based on wrangler config env. For example if wrangler config has env, `main` for production build and `dev` or `staging` for non-production builds, `platformProxy.environment` can be set as `dev` or `staging`.
For local development, if you want to use Cloudflare's local bindings like D1, KV etc., `platformProxy.environment` may be set, based on wrangler config env. For example if wrangler config has env, `main` for production build and `dev` or `staging` for non-production builds, `platformProxy.environment` can be set as `dev` or `staging`.

@benmccann benmccann changed the title platformProxy.environment for cloudflare's local bindings docs: platformProxy.environment for Cloudflare's local bindings Sep 13, 2025
@benmccann benmccann added the documentation Improvements or additions to documentation label Sep 13, 2025
Copy link
Member

@benmccann benmccann left a comment

Choose a reason for hiding this comment

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

I find this to be wordy and repetitive. E.g. the existing sentence says that it's local and then you repeat twice more right off the bat that it's local. The Cloudflare docs just say "The environment to use." which I think is fully sufficient

@teemingc
Copy link
Member

I'm against documenting how Cloudflare's getPlatformProxy works in the SvelteKit documentation. It was purposely written to link to Cloudflare's docs so that we don't have to duplicate the information here or maintain it if they change how it works. If its use is unclear, I'd recommend opening an issue in the Cloudflare docs instead https://github.com/cloudflare/cloudflare-docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pkg:adapter-cloudflare
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants