Support undefined/null as unset in setEnvVars #27609
Open
+88
−6
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
Document new behavior where undefined/null values in setEnvVars, exec options, and session creation now unset variables instead of throwing errors. - Add new 'Unsetting environment variables' section with examples - Update type signatures to Record<string, string | undefined> - Add examples showing undefined behavior in all env contexts - Document use cases for conditional environment setup Related to cloudflare/sandbox-sdk PR #342
agents-git-bot
bot
requested review from
a team,
ghostwriternr and
whoiskatrin
as code owners
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
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
Document behavior change where undefined/null values in environment variable APIs now unset variables instead of throwing errors.
Related to cloudflare/sandbox-sdk PR #342: cloudflare/sandbox-sdk#342
Changes
Record<string, string | undefined>setEnvVars(),exec(),startProcess(), andcreateSession()parameter docsKey behavior changes
Before:
sandbox.setEnvVars({ KEY: undefined })threw a runtime errorAfter:
sandbox.setEnvVars({ KEY: undefined })runsunset KEYThis enables idiomatic JavaScript patterns: