Skip to main content

Interface: LoadClientConnectConfigOptions

Options for loadClientConnectConfig.

Extends​

Properties​

configFileStrict?​

optional configFileStrict?: boolean

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

Inherited from​

LoadClientProfileOptions.configFileStrict

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.

Inherited from​

LoadClientProfileOptions.configSource

disableEnv?​

optional disableEnv?: boolean

If true, environment variable loading and overriding is disabled.

Inherited from​

LoadClientProfileOptions.disableEnv

disableFile?​

optional disableFile?: boolean

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

Inherited from​

LoadClientProfileOptions.disableFile

extensions?​

optional extensions?: ClientConfigExtension[]

Experimental

Extensions to apply to the loaded profile. After the profile is converted to connection options, each extension is called in order and any plugin it returns is appended to connectionOptions.plugins. Extension names must be unique.

Client config extensions are an experimental feature; APIs may change without notice.

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.

Inherited from​

LoadClientProfileOptions.overrideEnvVars

profile?​

optional profile?: string

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

Inherited from​

LoadClientProfileOptions.profile