Skip to main content

Interface: ClientConfigExtension

Experimental

An extension that takes existing config and emits a plugin to apply additional config to the client. Extensions are passed to loadClientConnectConfig via LoadClientConnectConfigOptions.extensions.

An extension's TOML config lives in the profile.<profile>.ext.<name> table, available as profile.ext?.[name]. Extensions are recommended to use a TEMPORAL_EXT_<NAME>_ prefix for their env vars.

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

Properties​

name​

readonly name: string

Experimental

The extension's table key under profile.<profile>.ext. Must be non-empty and unique among loaded extensions.

Methods​

clientPlugin()​

clientPlugin(request): ClientConfigExtensionPlugin | undefined

Experimental

Reads this extension's config from the profile and env, and returns a plugin that applies it, or undefined if there's nothing to apply. Errors thrown are wrapped with the extension name.

Parameters​

request​

ClientConfigExtensionRequest

Returns​

ClientConfigExtensionPlugin | undefined