Interface: ClientOptions

Extends

• BaseClientOptions

Properties

connection?

optional connection?: ConnectionLike

Connection to use to communicate with the server.

By default, connects to localhost.

Connections are expensive to construct and should be reused.

Inherited from

BaseClientOptions.connection

---

dataConverter?

optional dataConverter?: DataConverter

DataConverter to use for serializing and deserializing payloads

Inherited from

BaseClientOptions.dataConverter

---

identity?

optional identity?: string

Identity to report to the server

Default

${process.pid}@${os.hostname()}

Inherited from

BaseClientOptions.identity

---

interceptors?

optional interceptors?: ClientInterceptors

Used to override and extend default Connection functionality

Useful for injecting auth headers and tracing Workflow executions

---

namespace?

optional namespace?: string

Server namespace

Default

default

Inherited from

BaseClientOptions.namespace

---

payloadCache?

optional payloadCache?: false | PayloadCache

Experimental

Payload cache shared by this client, or false to disable payload caching.

Default

false

Inherited from

BaseClientOptions.payloadCache

---

plugins?

optional plugins?: ClientPlugin[]

Experimental

List of plugins to register with the client.

Plugins allow you to extend and customize the behavior of Temporal clients. They can intercept and modify client creation.

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

---

workflow?

optional workflow?: object

queryRejectCondition?

optional queryRejectCondition?: QueryRejectCondition

Should a query be rejected by closed and failed workflows

Default

undefined, which means that closed and failed workflows are still queryable