Skip to main content

Interface: WorkflowClientOptions

client.WorkflowClientOptions

Properties#

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: WorkflowClientInterceptors

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


queryRejectCondition#

Optional queryRejectCondition: QueryRejectCondition

Should a query be rejected by closed and failed workflows

default QUERY_REJECT_CONDITION_UNSPECIFIED which means that closed and failed workflows are still queryable


workflowDefaults#

Optional workflowDefaults: Partial<WorkflowOptions>

Apply default options for starting new Workflows.

These defaults are shallowly merged with options provided to methods that start Workflows e.g. WorkflowHandle.start.