Sync docs from cloudflare/sandbox-sdk#264: Fix type error when extending Sandbox class #26828
+90
−4
Conversation
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
Update API documentation to reflect TypeScript generic type parameters added to getSandbox(), SandboxEnv, and proxyToSandbox(). These changes fix type errors when extending the Sandbox class with custom methods. Changes: - Update getSandbox() signature to show generic type parameter - Add section on extending Sandbox class with example - Document proxyToSandbox() function with generic types - Document SandboxEnv type helper for custom Sandbox classes Related to cloudflare/sandbox-sdk#264 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
agents-git-bot
bot
requested review from
a team and
whoiskatrin
as code owners
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
|
Preview URL: https://670b2e04.preview.developers.cloudflare.com Files with changes (up to 15) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Syncs documentation updates from cloudflare/sandbox-sdk#264.
This PR documents the TypeScript generic type parameters added to
getSandbox(),SandboxEnv, andproxyToSandbox()that fix type errors when extending the Sandbox class with custom methods.Changes
getSandbox()signature to show generic type parameter<T extends Sandbox<any>>proxyToSandbox()function including generic type parametersSandboxEnv<T>type helper for defining environment types with custom Sandbox classesWhy These Changes
The original PR fixed a TypeScript type error where users extending the
Sandboxclass would get type errors when passing their namespace togetSandbox()andproxyToSandbox(). The functions and types are now generic to properly support extended classes.This documentation update:
Related Links
🤖 Auto-generated PR from cloudflare/sandbox-sdk documentation sync workflow