envconfig
Interfaces
- ClientConfig
- ClientConfigExtension
- ClientConfigExtensionRequest
- ClientConfigFromTomlOptions
- ClientConfigProfile
- ClientConfigTLS
- ClientConnectConfig
- LoadClientConfigOptions
- LoadClientConnectConfigOptions
- LoadClientProfileOptions
Type Aliases
ClientConfigExtensionPlugin
ClientConfigExtensionPlugin =
ConnectionPlugin&NativeConnectionPlugin
Experimental
Plugin returned by a ClientConfigExtension.
The connection options returned by loadClientConnectConfig may be passed to either Connection.connect (from
@temporalio/client) or NativeConnection.connect (from @temporalio/worker), so a plugin that modifies connection
options should implement both configureConnection and configureNativeConnection. Plugins registered on a
connection are also passed to clients (and, for NativeConnection, workers) built from it, so the plugin may also
implement other plugin interfaces such as ClientPlugin or WorkerPlugin. SimplePlugin from @temporalio/plugin
implements all of these.
Client config extensions are an experimental feature; APIs may change without notice.
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
Returns
Uint8Array
fromTomlConfig()
fromTomlConfig(
tomlConfig):ClientConfig
Converts a TOML client configuration structure to a ClientConfig.
Parameters
tomlConfig
TomlClientConfig
Returns
fromTomlProfile()
fromTomlProfile(
tomlProfile):ClientConfigProfile
Converts a TOML profile structure to a ClientConfigProfile.
Parameters
tomlProfile
TomlClientConfigProfile
Returns
loadClientConfig()
loadClientConfig(
options):ClientConfig
Parameters
options
Returns
loadClientConfigFromToml()
loadClientConfigFromToml(
tomlData,options):ClientConfig
Parameters
tomlData
Uint8Array
options
Returns
loadClientConfigProfile()
loadClientConfigProfile(
options?):ClientConfigProfile
Parameters
options?
Returns
loadClientConnectConfig()
loadClientConnectConfig(
options?):ClientConnectConfig
Loads a client configuration profile and converts it to connection options, then applies any LoadClientConnectConfigOptions.extensions. This is effectively a shortcut for loadClientConfigProfile + toClientOptions, plus extensions.
Parameters
options?
LoadClientConnectConfigOptions
Returns
loadConfigData()
loadConfigData(
source?):Uint8Array<ArrayBufferLike> |undefined
Loads configuration data from a ConfigDataSource and returns it as a Uint8Array.
Parameters
source?
Returns
Uint8Array<ArrayBufferLike> | undefined
toClientOptions()
toClientOptions(
profile):ClientConnectConfig
Parameters
profile
Returns
toTomlConfig()
toTomlConfig(
config):TomlClientConfig
Converts a ClientConfig to a TOML client configuration structure.
Parameters
config
Returns
TomlClientConfig
toTomlProfile()
toTomlProfile(
profile):TomlClientConfigProfile
Converts a ClientConfigProfile to a TOML profile structure.
Parameters
profile
Returns
TomlClientConfigProfile