Upgrading dotenv 17 to 18
Breaking17.4.2 → 18.0.9Breaking2New2Changed10Fixed3Other3
BreakingUpgrade verdict
2 breaking changes.
In plain terms
- Projects that relied on encrypted .env.vault files will no longer work with this version.
- The old way of preloading dotenv no longer works. Run your command through the dotenv CLI instead.
Must act 2 items need code or config changes
What you must change
Breaking2
Removes .env.vault support.
.env.vaultRemoves preloading; use the CLI
dotenv run -- your-command instead.dotenv runAPI changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- added:
function config(options?: DotenvConfigOptions): DotenvConfigOutput - added:
function configDotenv(options?: DotenvConfigOptions): DotenvConfigOutput - added:
function parse<T extends DotenvParseOutput = DotenvParseOutput>(src: string | Buffer, options?: DotenvParseOptions): T - added:
function populate(processEnv: DotenvPopulateInput, parsed: DotenvPopulateInput, options?: DotenvPopulateOptions): DotenvPopulateOutput - added:
index DotenvParseOutput[name: string]: string - added:
index DotenvPopulateInput[name: string]: string | undefined - added:
index DotenvPopulateOutput[name: string]: string | undefined - added:
interface DotenvConfigOptions - added:
interface DotenvConfigOutput - added:
interface DotenvParseOptions - added:
interface DotenvParseOutput - added:
interface DotenvPopulateInput - added:
interface DotenvPopulateOptions - added:
interface DotenvPopulateOutput - added:
property DotenvConfigOptions.debug?: boolean - added:
property DotenvConfigOptions.encoding?: string - added:
property DotenvConfigOptions.fast?: boolean - added:
property DotenvConfigOptions.override?: boolean - added:
property DotenvConfigOptions.path?: string | string[] | URL - added:
property DotenvConfigOptions.processEnv?: DotenvPopulateInput - added:
property DotenvConfigOptions.quiet?: boolean - added:
property DotenvConfigOutput.error?: DotenvError - added:
property DotenvConfigOutput.parsed?: DotenvParseOutput - added:
property DotenvParseOptions.fast?: boolean - added:
property DotenvPopulateOptions.debug?: boolean - added:
property DotenvPopulateOptions.override?: boolean
- removed:
function config(options?: DotenvConfigOptions): DotenvConfigOutput - removed:
function configDotenv(options?: DotenvConfigOptions): DotenvConfigOutput - removed:
function decrypt(encrypted: string, keyStr: string): string - removed:
function parse<T extends DotenvParseOutput = DotenvParseOutput>(src: string | Buffer): T - removed:
function populate(processEnv: DotenvPopulateInput, parsed: DotenvPopulateInput, options?: DotenvPopulateOptions): DotenvPopulateOutput - removed:
index DotenvParseOutput[name: string]: string - removed:
index DotenvPopulateInput[name: string]: string | undefined - removed:
index DotenvPopulateOutput[name: string]: string - removed:
interface DotenvConfigOptions - removed:
interface DotenvConfigOutput - removed:
interface DotenvParseOutput - removed:
interface DotenvPopulateInput - removed:
interface DotenvPopulateOptions - removed:
interface DotenvPopulateOutput - removed:
property DotenvConfigOptions.DOTENV_KEY?: string - removed:
property DotenvConfigOptions.debug?: boolean - removed:
property DotenvConfigOptions.encoding?: string - removed:
property DotenvConfigOptions.override?: boolean - removed:
property DotenvConfigOptions.path?: string | string[] | URL - removed:
property DotenvConfigOptions.processEnv?: DotenvPopulateInput - removed:
property DotenvConfigOptions.quiet?: boolean - removed:
property DotenvConfigOutput.error?: DotenvError - removed:
property DotenvConfigOutput.parsed?: DotenvParseOutput - removed:
property DotenvPopulateOptions.debug?: boolean - removed:
property DotenvPopulateOptions.override?: boolean