Interface DotenvFs

Minimal filesystem port used by the FS-level editor adapter.

interface DotenvFs {
    copyFile(src: string, dest: string): Promise<void>;
    pathExists(p: string): Promise<boolean>;
    readFile(p: string): Promise<string>;
    writeFile(p: string, contents: string): Promise<void>;
}

Index

Methods

copyFile pathExists readFile writeFile

Methods

copyFile

copyFile(src: string, dest: string): Promise<void>
Copy a file.
Parameters
- src: string
  Source path.
- dest: string
  Destination path.
Returns Promise<void>
- Defined in src/dotenv/edit/types.ts:293

pathExists

pathExists(p: string): Promise<boolean>
Return true when a path exists.
Parameters
- p: string
  Path to check.
Returns Promise<boolean>
- Defined in src/dotenv/edit/types.ts:273

readFile

readFile(p: string): Promise<string>
Read a UTF-8 text file.
Parameters
- p: string
  Path to read.
Returns Promise<string>
- Defined in src/dotenv/edit/types.ts:279

writeFile

writeFile(p: string, contents: string): Promise<void>
Write a UTF-8 text file.
Parameters
- p: string
  Path to write.
- contents: string
  File contents.
Returns Promise<void>
- Defined in src/dotenv/edit/types.ts:286