Skip to main content

envconfig

Interfaces​

Type Aliases​

ConfigDataSource​

ConfigDataSource = { path: string; } | { data: string | Uint8Array; }

A data source for configuration, which can be a path to a file, the string contents of a file, or raw bytes.

Functions​

clientConfigToToml()​

clientConfigToToml(config): Uint8Array

Parameters​

config​

ClientConfig

Returns​

Uint8Array

fromTomlConfig()​

fromTomlConfig(tomlConfig): ClientConfig

Converts a TOML client configuration structure to a ClientConfig.

Parameters​

tomlConfig​

TomlClientConfig

Returns​

ClientConfig

fromTomlProfile()​

fromTomlProfile(tomlProfile): ClientConfigProfile

Converts a TOML profile structure to a ClientConfigProfile.

Parameters​

tomlProfile​

TomlClientConfigProfile

Returns​

ClientConfigProfile

loadClientConfig()​

loadClientConfig(options): ClientConfig

Parameters​

options​

LoadClientConfigOptions

Returns​

ClientConfig

loadClientConfigFromToml()​

loadClientConfigFromToml(tomlData, options): ClientConfig

Parameters​

tomlData​

Uint8Array

options​

ClientConfigFromTomlOptions

Returns​

ClientConfig

loadClientConfigProfile()​

loadClientConfigProfile(options?): ClientConfigProfile

Parameters​

options?​

LoadClientProfileOptions

Returns​

ClientConfigProfile

loadClientConnectConfig()​

loadClientConnectConfig(options?): ClientConnectConfig

Parameters​

options?​

LoadClientProfileOptions

Returns​

ClientConnectConfig

loadConfigData()​

loadConfigData(source?): Uint8Array<ArrayBufferLike> | undefined

Loads configuration data from a ConfigDataSource and returns it as a Uint8Array.

Parameters​

source?​

ConfigDataSource

Returns​

Uint8Array<ArrayBufferLike> | undefined

toClientOptions()​

toClientOptions(profile): ClientConnectConfig

Parameters​

profile​

ClientConfigProfile

Returns​

ClientConnectConfig

toTomlConfig()​

toTomlConfig(config): TomlClientConfig

Converts a ClientConfig to a TOML client configuration structure.

Parameters​

config​

ClientConfig

Returns​

TomlClientConfig

toTomlProfile()​

toTomlProfile(profile): TomlClientConfigProfile

Converts a ClientConfigProfile to a TOML profile structure.

Parameters​

profile​

ClientConfigProfile

Returns​

TomlClientConfigProfile