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

    Interface GetDotenvOptions

    Options passed programmatically to getDotenv.

    interface GetDotenvOptions {
        defaultEnv?: string;
        dotenvToken: string;
        dynamic?: GetDotenvDynamic;
        dynamicPath?: string;
        env?: string;
        excludeDynamic?: boolean;
        excludeEnv?: boolean;
        excludeGlobal?: boolean;
        excludePrivate?: boolean;
        excludePublic?: boolean;
        loadProcess?: boolean;
        log?: boolean;
        logger?: Logger;
        outputPath?: string;
        paths?: string[];
        privateToken?: string;
        useConfigLoader?: boolean;
        vars?: ProcessEnv;
    }
    Index

    Properties

    defaultEnv? dotenvToken dynamic? dynamicPath? env? excludeDynamic? excludeEnv? excludeGlobal? excludePrivate? excludePublic? loadProcess? log? logger? outputPath? paths? privateToken? useConfigLoader? vars?

    Properties

    defaultEnv?: string

    default target environment (used if env is not provided)

    dotenvToken: string

    token indicating a dotenv file

    dynamic?: GetDotenvDynamic

    Programmatic dynamic variables map. When provided, this takes precedence over GetDotenvOptions.dynamicPath.

    dynamicPath?: string

    path to JS/TS module default-exporting an object keyed to dynamic variable functions

    env?: string

    target environment

    excludeDynamic?: boolean

    exclude dynamic variables from loading

    excludeEnv?: boolean

    exclude environment-specific variables from loading

    excludeGlobal?: boolean

    exclude global variables from loading

    excludePrivate?: boolean

    exclude private variables from loading

    excludePublic?: boolean

    exclude public variables from loading

    loadProcess?: boolean

    load dotenv variables to process.env

    log?: boolean

    log loaded dotenv variables to logger

    logger?: Logger

    logger object (defaults to console)

    outputPath?: string

    if populated, writes consolidated dotenv file to this path (follows dotenvExpand rules)

    paths?: string[]

    array of input directory paths

    privateToken?: string

    filename token indicating private variables

    useConfigLoader?: boolean

    Reserved: config loader flag (no-op). The plugin-first host and generator paths already use the config loader/overlay pipeline unconditionally (no-op when no config files are present). This flag is accepted for forward compatibility but currently has no effect.

    vars?: ProcessEnv

    explicit variables to include

    Settings

    Member Visibility

    On This Page

    Properties