docs(typescript): document guardProcessEnvAccess - #6856
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs(typescript): document guardProcessEnvAccess#6856devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1788541534-ts-guard-process-env-access.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The TypeScript SDK generator (3.89.0) gained an opt-in
guardProcessEnvAccessconfig option. When enabled, the generated auth providers (API key/header, bearer, basic, OAuth) only read credential environment variables behind atypeof process !== "undefined"check. This matters for customers whose SDKs run in browsers, Cloudflare Workers, Deno, or other non-Node runtimes: todayprocess.env?.[KEY]throwsReferenceError: process is not definedwhen a credential isn't passed to the client, and with the option enabled the client instead surfaces its normal "provideapiKeyor set theX_API_KEYenvironment variable" error. Defaultfalsekeeps generated output unchanged.Implements docs for: feat(typescript): add opt-in guardProcessEnvAccess for auth provider env reads (fern-api/fern#17605)
Summary
fern/products/sdks/generators/typescript/configuration.mdx(TypeScript configuration reference, https://buildwithfern.com/learn/sdks/generators/typescript/configuration): new<ParamField path="guardProcessEnvAccess">entry, placed alphabetically betweengenerateSubpackageExportsandincludeContentHeadersOnFileDownloadResponse, with a shortgenerators.ymlexample.No changelog changes (already covered by the 2026-09-02 TypeScript generator changelog entry). Vale and
fern check --warningspass on the added content; the remaining Vale findings in the file are pre-existing.Link to Devin session: https://app.devin.ai/sessions/ea4d0d848e454e0189ddb0aef1ac603d
Open in Devin Desktop: https://app.devin.ai/desktop/session/ea4d0d848e454e0189ddb0aef1ac603d?variant=devin