Skip to main content

Interface: LoadClientProfileOptions

envconfig.LoadClientProfileOptions

Options for loading a client configuration profile.

Properties​

configFileStrict​

• Optional configFileStrict: boolean

If true, will error on unrecognized keys in the TOML file.

configSource​

• Optional configSource: ConfigDataSource

If present, this is used as the configuration source instead of default file locations. This can be a path to the file or the string/byte contents of the file.

disableEnv​

• Optional disableEnv: boolean

If true, environment variable loading and overriding is disabled.

disableFile​

• Optional disableFile: boolean

If true, file loading is disabled. This is only used when configSource is not present.

overrideEnvVars​

• Optional overrideEnvVars: Record<string, string>

A dictionary of environment variables to use for loading and overrides. If not provided, the current process's environment is used.

profile​

• Optional profile: string

The name of the profile to load from the config. Defaults to "default".