Skip to content

update getPlatformProxy docs by generalizing wrangler.toml references and adding assets bindings support #19300

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

Closed
wants to merge 2 commits into from
Closed

update getPlatformProxy docs by generalizing wrangler.toml references and adding assets bindings support #19300

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f00307
generalize references to `wrangler.toml` in the wrangler api guide
dario-piotrowicz Jan 19, 2025
caec650
add static asset bindings to list of `getPlatformProxy` supported bin…
dario-piotrowicz Jan 19, 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
10 changes: 5 additions & 5 deletions src/content/docs/workers/wrangler/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ const platform = await getPlatformProxy(options);

The path to the config file to use.

If no path is specified the default behavior is to search from the current directory up the filesystem for a `wrangler.toml` to use.
If no path is specified the default behavior is to search from the current directory up the filesystem for a [Wrangler configuration file](/workers/wrangler/configuration/) to use.

**Note:** this field is optional but if a path is specified it must point to a valid file on the filesystem.

Expand Down Expand Up @@ -295,7 +295,7 @@ const platform = await getPlatformProxy(options);

### Usage

The `getPlatformProxy` function uses bindings found in `wrangler.toml`. For example, if you have an [environment variable](/workers/configuration/environment-variables/#add-environment-variables-via-wrangler) configuration set up in `wrangler.toml`:
The `getPlatformProxy` function uses bindings found in [Wrangler configuration files](/workers/wrangler/configuration/). For example, if you have such an [environment variable](/workers/configuration/environment-variables/#add-environment-variables-via-wrangler) in your configuration:

import { WranglerConfig } from "~/components";

Expand Down Expand Up @@ -326,7 +326,7 @@ This will print the following output: `MY_VARIABLE = test`.

### Supported bindings

All supported bindings found in your `wrangler.toml` are available to you via `env`.
All supported bindings found in your [Wrangler configuration](/workers/wrangler/configuration/) are available to you via `env`.

The bindings supported by `getPlatformProxy` are:

Expand All @@ -342,8 +342,6 @@ The bindings supported by `getPlatformProxy` are:

For example, you might have the following file read by `getPlatformProxy`.



<WranglerConfig>

```toml
Expand All @@ -365,6 +363,8 @@ The bindings supported by `getPlatformProxy` are:

- [D1 database bindings](/d1/worker-api/)

- [Static Asset bindings](/workers/static-assets/binding/#binding)

- [Hyperdrive bindings](/hyperdrive)

:::note[Hyperdrive values are simple passthrough ones]
Expand Down
Loading