Interface: ClientOptions

client.ClientOptions

Hierarchy

• BaseClientOptions

  ↳ ClientOptions

  ↳↳ TestEnvClientOptions

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

---

workflow

• Optional workflow: Object

Type declaration

Name	Type	Description
queryRejectCondition?	QueryRejectCondition	Should a query be rejected by closed and failed workflows Default undefined, which means that closed and failed workflows are still queryable