Interface: ClientConnectionOptions

Defined in: src/interfaces.ts:80

Configuration options for Temporal client connection. Used for establishing connection to Temporal server.

Example

const clientOptions: ClientConnectionOptions = {
  address: 'localhost:7233',
  namespace: 'default',
  tls: false,
  metadata: { 'client-version': '1.0.0' }
};

Properties

address

address: string

Defined in: src/interfaces.ts:81

---

apiKey?

optional apiKey?: string

Defined in: src/interfaces.ts:84

---

dataConverter?

optional dataConverter?: DataConverter

Defined in: src/interfaces.ts:104

Custom client-side DataConverter. Threaded into new Client({ dataConverter }). Required alongside the worker's own workerOptions.dataConverter for Temporal's codec server payload encryption pattern — the two are independent SDK options and both must be set for encrypted payloads to round-trip correctly.

---

grpcCompression?

optional grpcCompression?: GrpcCompressionConfig

Defined in: src/interfaces.ts:97

gRPC compression for the worker connection (NativeConnection). Temporal SDK 1.19 enables gzip compression by default; set { codec: 'none' } to opt out if your server can't decompress it. Has no effect on the plain gRPC client connection, which does not compress by default.

---

interceptors?

optional interceptors?: ClientInterceptors

Defined in: src/interfaces.ts:90

Client-level interceptors (workflow, activity, schedule, nexus). Threaded into new Client({ interceptors }). Useful for OTel tracing/metadata propagation.

---

metadata?

optional metadata?: Record<string, string>

Defined in: src/interfaces.ts:83

---

namespace?

optional namespace?: string

Defined in: src/interfaces.ts:85

---

tls?

optional tls?: boolean | TLSConfig

Defined in: src/interfaces.ts:82