Skip to main content

Interface: NativeConnectionOptions

worker.NativeConnectionOptions

Properties​

address​

• Optional address: string

The address of the Temporal server to connect to, in hostname:port format.

Port defaults to 7233. Raw IPv6 addresses must be wrapped in square brackets (e.g. [ipv6]:port).

Default

localhost:7233

apiKey​

• Optional apiKey: string

API key for Temporal. This becomes the "Authorization" HTTP header with "Bearer " prepended. This is only set if RPC metadata doesn't already have an "authorization" key.

disableErrorCodeMetricTags​

• Optional disableErrorCodeMetricTags: boolean

If set to true, error code labels will not be included on request failure metrics emitted by this Client.

Default

false

metadata​

• Optional metadata: Record<string, string>

Optional mapping of gRPC metadata (HTTP headers) to send with each request to the server.

Set statically at connection time, can be replaced later using NativeConnection.setMetadata.

proxy​

• Optional proxy: HttpConnectProxyConfig

Proxying configuration.

tls​

• Optional tls: null | boolean | TLSConfig

TLS configuration options.

Pass a falsy value to use a non-encrypted connection or true or {} to connect with TLS without any customization.