Skip to main content

Interface: TemporalConnectionOptions

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:11

gRPC and Temporal Server connection options

Properties​

address?​

optional address?: string

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:19

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 | (() => string)

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:100

API key for Temporal. This becomes the "Authorization" HTTP header with "Bearer " prepended. This is mutually exclusive with the Authorization header in ConnectionOptions.metadata.

You may provide a static string or a callback. Also see Connection.withApiKey or Connection.setApiKey

callCredentials?​

optional callCredentials?: CallCredentials[]

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:58

gRPC call credentials.

CallCredentials generaly modify metadata; they can be attached to a connection to affect all method calls made using that connection. They can be created using some of the factory methods defined here

If callCredentials are specified, they will be composed with channel credentials (either the one created implicitely by using the tls option, or the one specified explicitly through credentials). Notice that gRPC doesn't allow registering callCredentials on insecure connections.

channelArgs?​

optional channelArgs?: ChannelOptions

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:74

GRPC Channel arguments

See​

option descriptions here

By default the SDK sets the following keepalive arguments:

grpc.keepalive_permit_without_calls: 1
grpc.keepalive_time_ms: 30_000
grpc.keepalive_timeout_ms: 15_000

To opt-out of keepalive, override these keys with undefined.

connectTimeout?​

optional connectTimeout?: Duration

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:110

Milliseconds to wait until establishing a connection with the server.

Used either when connecting eagerly with Connection.connect or calling Connection.ensureConnected.

Format​

number of milliseconds or ms-formatted string

Default​

10 seconds

credentials?​

optional credentials?: ChannelCredentials

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:45

gRPC channel credentials.

ChannelCredentials are things like SSL credentials that can be used to secure a connection. There may be only one ChannelCredentials. They can be created using some of the factory methods defined here

Specifying a prebuilt ChannelCredentials should only be required for advanced use cases. For simple TLS use cases, using the tls property is recommended. To register CallCredentials (eg. metadata-based authentication), use the callCredentials property.

Either tls or this may be specified for configuring TLS

interceptors?​

optional interceptors?: Interceptor[]

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:85

gRPC interceptors which will be applied to every RPC call performed by this connection. By default, an interceptor will be included which automatically retries retryable errors. If you do not wish to perform automatic retries, set this to an empty list (or a list with your own interceptors). If you want to add your own interceptors while keeping the default retry behavior, add this to your list of interceptors: makeGrpcRetryInterceptor(defaultGrpcRetryOptions()). See:

  • makeGrpcRetryInterceptor
  • defaultGrpcRetryOptions

metadata?​

optional metadata?: Metadata

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:92

Optional mapping of gRPC metadata (HTTP headers) to send with each request to the server. Setting the Authorization header is mutually exclusive with the apiKey option.

In order to dynamically set metadata, use Connection.withMetadata

plugins?​

optional plugins?: ConnectionPlugin[]

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:119

Experimental

List of plugins to register with the connection.

Plugins allow you to configure the connection options. Any plugins provided will also be passed to any client built from this connection.

Plugins is an experimental feature; APIs may change without notice.

tls?​

optional tls?: boolean | TLSConfig | null

Defined in: node_modules/@temporalio/client/lib/connection.d.ts:31

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

For advanced scenario, a prebuilt grpc.ChannelCredentials object may instead be specified using the credentials property.

Either credentials or this may be specified for configuring TLS

Default​

TLS is disabled