Skip to content

add experimental remoteBindings option to getPlatformProxy docs #23136

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

Merged
merged 2 commits into from
Jun 20, 2025
Merged

add experimental remoteBindings option to getPlatformProxy docs #23136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a061d4e
add experimental `remoteBindings` option to `getPlatformProxy` docs
dario-piotrowicz Jun 19, 2025
44d7f52
update and improve `maybeStartOrUpdateRemoteProxySession` docs
dario-piotrowicz Jun 20, 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
7 changes: 2 additions & 5 deletions src/content/docs/workers/development-testing/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,12 +368,9 @@ the bindings in an `Unstable_Config` object into a structure that can be passed
This wrapper simplifies proxy session management. It takes:

- The path to your Wrangler config, or an object with remote bindings.
- The current proxy session details (or `null` if none).
- The current proxy session details (this parameter can be set to `null` or not being provided if none).

It returns:

- `null` if no proxy session is needed.
- An object with the proxy session details if started or updated.
It returns an object with the proxy session details if started or updated, or `null` if no proxy session is needed.

The function:

Expand Down
6 changes: 6 additions & 0 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 @@ -300,6 +300,12 @@ const platform = await getPlatformProxy(options);

**Note:** If you use `wrangler`'s `--persist-to` option, note that this option adds a subdirectory called `v3` under the hood while `getPlatformProxy`'s `persist` does not. For example, if you run `wrangler dev --persist-to ./my-directory`, to reuse the same location using `getPlatformProxy`, you will have to specify: `persist: { path: "./my-directory/v3" }`.

- `experimental` `{ remoteBindings: boolean }`

Object used to enable experimental features, no guarantees are made to the stability of this API, use at your own risk.

- `remoteBindings` Enables `getPlatformProxy` to connect to [remote bindings](/workers/development-testing/#remote-bindings).

### Return Type

`getPlatformProxy()` returns a `Promise` resolving to an object containing the following fields.
Expand Down
Loading