Class EnvEditor

Environment editor for managing and modifying .env files. Provides functionality to load, edit, and save environment configuration files.

Index

Constructors

Methods

create load add toJSON save

Constructors

constructor

new EnvEditor(appRoot: URL): EnvEditor
Constructs a new EnvEditor instance
Parameters
- appRoot: URL
  The application root directory URL
Returns EnvEditor
- Defined in src/editor.ts:55

Methods

`Static`create

create(appRoot: URL): Promise<EnvEditor>
Creates an instance of env editor and loads .env files contents.
Parameters
- appRoot: URL
  The application root directory URL
Returns Promise<EnvEditor>
Promise resolving to an EnvEditor instance
- Defined in src/editor.ts:43

load

load(): Promise<void>
Loads .env files for editing. Only ".env" and ".env.example" files are picked for editing.

Returns Promise<void>
Promise that resolves when files are loaded
- Defined in src/editor.ts:66

add

add(
    key: string,
    value: string | number | boolean,
    withEmptyExampleValue?: boolean,
): void
Add key-value pair to the dot-env files. If withEmptyExampleValue is true then the key will be added with an empty value to the .env.example file.
Parameters
- key: string
  The environment variable key
- value: string | number | boolean
  The environment variable value
- withEmptyExampleValue: boolean = false
  Whether to add empty value to .env.example file
Returns void
- Defined in src/editor.ts:92

toJSON

toJSON(): { contents: string[]; path: string }[]
Returns the loaded files as JSON

Returns { contents: string[]; path: string }[]
Array of file objects with contents and paths
- Defined in src/editor.ts:111

save

save(): Promise<void>
Save changes to the disk

Returns Promise<void>
Promise that resolves when files are saved
- Defined in src/editor.ts:120