env/update_env_variable.ts

Write updates to .env files while preserving formatting.

Declarations
#

2 declarations

view source

update_env_variable
#

env/update_env_variable.ts view source

(key: string, value: string, options: UpdateEnvVariableOptions): Promise<void>

Updates or adds an environment variable in the .env file. Preserves existing formatting, comments, and other variables.

Behavior: - Duplicate keys: updates the LAST occurrence (matches dotenv behavior) - Inline comments: preserved after the value (e.g., KEY=value # comment) - Quote style: preserved from original (quoted/unquoted)

key

the environment variable name (e.g., 'SOME_CONFIGURATION_KEY')

type string

value

the new value for the environment variable

type string

options

file path and optional read/write overrides

type UpdateEnvVariableOptions

returns

Promise<void>

throws

  • Error - if the file read fails for any reason other than `ENOENT`, or if the write fails

UpdateEnvVariableOptions
#

env/update_env_variable.ts view source

UpdateEnvVariableOptions

Options for updating environment variables in a .env file.

env_file_path

Path to the .env file.

type string

read_file

Function to read file contents (defaults to node:fs/promises readFile).

type (path: string, encoding: string) => Promise<string>

write_file

Function to write file contents (defaults to node:fs/promises writeFile).

type (path: string, content: string, encoding: string) => Promise<void>