Skip to main content

Interface: ClientOptions

client.ClientOptions

Hierarchy

Properties

connection

Optional connection: ConnectionLike

Connection to use to communicate with the server.

By default WorkflowClient connects to localhost.

Connections are expensive to construct and should be reused.


dataConverter

Optional dataConverter: DataConverter

DataConverter to use for serializing and deserializing payloads


identity

Optional identity: string

Identity to report to the server

Default

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


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


workflow

Optional workflow: Object

Type declaration

NameTypeDescription
queryRejectCondition?QueryRejectConditionShould a query be rejected by closed and failed workflows Default QUERY_REJECT_CONDITION_UNSPECIFIED which means that closed and failed workflows are still queryable