@karmaniverous/get-dotenv
    Preparing search index...

    Interface EditDotenvFileOptions

    Options for resolving and editing a dotenv file in a multi-path cascade.

    interface EditDotenvFileOptions {
        defaultEnv?: string;
        defaultSeparator?: string;
        dotenvToken?: string;
        duplicateKeys?: DotenvDuplicateKeyStrategy;
        env?: string;
        eol?: DotenvEolMode;
        fs?: DotenvFs;
        mode?: DotenvEditMode;
        nullBehavior?: "delete";
        paths: string[];
        privacy: DotenvTargetPrivacy;
        privateToken?: string;
        scope: DotenvTargetScope;
        searchOrder?: DotenvPathSearchOrder;
        templateExtension?: string;
        undefinedBehavior?: "skip";
    }

    Hierarchy (View Summary)

    Index

    Properties

    defaultEnv? defaultSeparator? dotenvToken? duplicateKeys? env? eol? fs? mode? nullBehavior? paths privacy privateToken? scope searchOrder? templateExtension? undefinedBehavior?

    Properties

    defaultEnv?: string

    Default environment name used when env is not provided.

    defaultSeparator?: string

    Separator to use when converting a bare-key placeholder into an assignment.

    '='

    dotenvToken?: string

    Base dotenv filename token.

    '.env'

    duplicateKeys?: DotenvDuplicateKeyStrategy

    Duplicate key handling strategy.

    'all'

    env?: string

    Selected environment name (used when scope is env).

    eol?: DotenvEolMode

    EOL normalization policy.

    'preserve'

    fs?: DotenvFs

    Optional filesystem port override (defaults to a Node FS adapter).

    mode?: DotenvEditMode

    Editing mode (merge vs sync).

    'merge'

    nullBehavior?: "delete"

    null behavior.

    'delete'

    paths: string[]

    Search paths (directories) to locate the target dotenv file.

    privacy: DotenvTargetPrivacy

    Privacy axis (public vs private).

    privateToken?: string

    Private token used for private dotenv files.

    'local'

    scope: DotenvTargetScope

    Scope axis (global vs env-specific).

    searchOrder?: DotenvPathSearchOrder

    Path search order.

    'reverse'

    templateExtension?: string

    Template extension used for bootstrap.

    When a target does not exist anywhere under paths, but a template exists (e.g. .env.local.template), the template will be copied to the target path and then edited in place.

    'template'

    undefinedBehavior?: "skip"

    undefined behavior.

    'skip'

    Settings

    Member Visibility

    On This Page

    Properties