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

    Interface GetDotenvConfig<Vars, Env>

    Typed config shape and builder for authoring JS/TS getdotenv config files.

    Compile-time only; the runtime loader remains schema-driven.

    interface GetDotenvConfig<Vars extends ProcessEnv, Env extends string = string> {
        dotenvToken?: string;
        dynamic?: DynamicMap<Vars>;
        envVars?: Record<Env, Partial<Vars>>;
        loadProcess?: boolean;
        log?: boolean;
        paths?: string | string[];
        plugins?: Record<string, unknown>;
        privateToken?: string;
        requiredKeys?: string[];
        rootOptionDefaults?: Partial<RootOptionsShape>;
        schema?: unknown;
        scripts?: ScriptsTable;
        shell?: string | boolean;
        vars?: Vars;
    }

    Type Parameters

    • Vars extends ProcessEnv
    • Env extends string = string
    Index

    Properties

    dotenvToken? dynamic? envVars? loadProcess? log? paths? plugins? privateToken? requiredKeys? rootOptionDefaults? schema? scripts? shell? vars?

    Properties

    dotenvToken?: string

    Token indicating a dotenv file.

    dynamic?: DynamicMap<Vars>

    Dynamic variable definitions.

    envVars?: Record<Env, Partial<Vars>>

    Environment-specific variables.

    loadProcess?: boolean

    Whether to load variables into process.env.

    log?: boolean

    Whether to log loaded variables.

    paths?: string | string[]

    Paths to search for dotenv files.

    plugins?: Record<string, unknown>

    Plugin configuration slices.

    privateToken?: string

    Token indicating private variables.

    requiredKeys?: string[]

    Keys required to be present in the final environment.

    rootOptionDefaults?: Partial<RootOptionsShape>

    Operational root defaults applied by the host (collapsed families; stringly form).

    schema?: unknown

    Validation schema (e.g. Zod).

    scripts?: ScriptsTable

    Scripts table.

    shell?: string | boolean

    Shell execution strategy.

    vars?: Vars

    Global variables.

    Settings

    Member Visibility

    On This Page

    Properties