Namespace: envconfig
Interfaces
- ClientConfig
- ClientConfigFromTomlOptions
- ClientConfigProfile
- ClientConfigTLS
- ClientConnectConfig
- LoadClientConfigOptions
- LoadClientProfileOptions
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
| Name | Type |
|---|---|
config | ClientConfig |
Returns
Uint8Array
fromTomlConfig
▸ fromTomlConfig(tomlConfig): ClientConfig
Converts a TOML client configuration structure to a ClientConfig.
Parameters
| Name | Type |
|---|---|
tomlConfig | TomlClientConfig |
Returns
fromTomlProfile
▸ fromTomlProfile(tomlProfile): ClientConfigProfile
Converts a TOML profile structure to a ClientConfigProfile.
Parameters
| Name | Type |
|---|---|
tomlProfile | TomlClientConfigProfile |
Returns
loadClientConfig
▸ loadClientConfig(options): ClientConfig
Parameters
| Name | Type |
|---|---|
options | LoadClientConfigOptions |
Returns
loadClientConfigFromToml
▸ loadClientConfigFromToml(tomlData, options): ClientConfig
Parameters
| Name | Type |
|---|---|
tomlData | Uint8Array |
options | ClientConfigFromTomlOptions |
Returns
loadClientConfigProfile
▸ loadClientConfigProfile(options?): ClientConfigProfile
Parameters
| Name | Type |
|---|---|
options? | LoadClientProfileOptions |
Returns
loadClientConnectConfig
▸ loadClientConnectConfig(options?): ClientConnectConfig
Parameters
| Name | Type |
|---|---|
options? | LoadClientProfileOptions |
Returns
loadConfigData
▸ loadConfigData(source?): Uint8Array | undefined
Loads configuration data from a ConfigDataSource and returns it as a Uint8Array.
Parameters
| Name | Type |
|---|---|
source? | ConfigDataSource |
Returns
Uint8Array | undefined
toClientOptions
▸ toClientOptions(profile): ClientConnectConfig
Parameters
| Name | Type |
|---|---|
profile | ClientConfigProfile |
Returns
toTomlConfig
▸ toTomlConfig(config): TomlClientConfig
Converts a ClientConfig to a TOML client configuration structure.
Parameters
| Name | Type |
|---|---|
config | ClientConfig |
Returns
TomlClientConfig
toTomlProfile
▸ toTomlProfile(profile): TomlClientConfigProfile
Converts a ClientConfigProfile to a TOML profile structure.
Parameters
| Name | Type |
|---|---|
profile | ClientConfigProfile |
Returns
TomlClientConfigProfile