Skip to content

Document ChildProcess environment behavior #6717

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
IMax153 merged 1 commit into from
Jul 28, 2026
Merged

Document ChildProcess environment behavior #6717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/document-child-process-env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"effect": patch
---

Document that `CommandOptions.extendEnv` defaults to `false` and that providing `env` without enabling it replaces the inherited child environment.
9 changes: 8 additions & 1 deletion packages/effect/src/unstable/process/ChildProcess.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,11 @@ export interface CommandOptions extends KillOptions {
* If `extendEnv` is set to `true`, the value of `env` will be merged with
* the value of `globalThis.process.env`, prioritizing the values in `env`
* when conflicts exist.
*
* **Gotchas**
*
* Without `extendEnv: true`, providing `env` replaces the inherited child
* environment. The child will not receive `PATH` unless `env` includes it.
*/
readonly env?: Record<string, string | undefined> | undefined
/**
Expand All @@ -392,7 +397,9 @@ export interface CommandOptions extends KillOptions {
*
* **Details**
*
* If set to `false`, only the value of `env` is used.
* If set to `false` and `env` is provided, only the value of `env` is used.
*
* @default false
*/
readonly extendEnv?: boolean | undefined
/**
Expand Down
Loading