Skip to main content

Namespace: client

Client for communicating with the Temporal service.

Interact with workflows using WorkflowClient or call GRPC methods directly using Connection.service.

Usage#

Classes#

Interfaces#

References#

DataConverter#

Re-exports: DataConverter


Headers#

Re-exports: Headers


Next#

Re-exports: Next


defaultDataConverter#

Re-exports: defaultDataConverter

Type aliases#

CompiledWorkflowOptions#

Ƭ CompiledWorkflowOptions: BaseWorkflowOptions & RequiredWorkflowOptions & { workflowExecutionTimeout?: google.protobuf.IDuration ; workflowRunTimeout?: google.protobuf.IDuration ; workflowTaskTimeout?: google.protobuf.IDuration }


ConnectionOptionsWithDefaults#

Ƭ ConnectionOptionsWithDefaults: Required<Omit<ConnectionOptions, "tls">>


DescribeWorkflowExecutionResponse#

Ƭ DescribeWorkflowExecutionResponse: IDescribeWorkflowExecutionResponse


GetWorkflowExecutionHistoryRequest#

Ƭ GetWorkflowExecutionHistoryRequest: IGetWorkflowExecutionHistoryRequest


ProtoFailure#

Ƭ ProtoFailure: temporal.api.failure.v1.IFailure


RequestCancelWorkflowExecutionResponse#

Ƭ RequestCancelWorkflowExecutionResponse: IRequestCancelWorkflowExecutionResponse


StartWorkflowExecutionRequest#

Ƭ StartWorkflowExecutionRequest: IStartWorkflowExecutionRequest


TerminateWorkflowExecutionResponse#

Ƭ TerminateWorkflowExecutionResponse: ITerminateWorkflowExecutionResponse


WorkflowClientOptionsWithDefaults#

Ƭ WorkflowClientOptionsWithDefaults: Required<WorkflowClientOptions>


WorkflowExecution#

Ƭ WorkflowExecution: IWorkflowExecution


WorkflowService#

Ƭ WorkflowService: WorkflowService

Variables#

LOCAL_DOCKER_TARGET#

Const LOCAL_DOCKER_TARGET: "127.0.0.1:7233"


WorkflowService#

WorkflowService: typeof WorkflowService

Functions#

addDefaults#

addDefaults(opts): WorkflowOptionsWithDefaults

Adds default values to workflowId and workflowIdReusePolicy to given workflow options.

Parameters#

NameType
optsWorkflowOptions

Returns#

WorkflowOptionsWithDefaults


compileWorkflowOptions#

compileWorkflowOptions(__namedParameters): CompiledWorkflowOptions

Parameters#

NameType
__namedParametersWorkflowOptionsWithDefaults

Returns#

CompiledWorkflowOptions


defaultConnectionOpts#

defaultConnectionOpts(): ConnectionOptionsWithDefaults

Returns#

ConnectionOptionsWithDefaults


defaultWorkflowClientOptions#

defaultWorkflowClientOptions(): WorkflowClientOptionsWithDefaults

Returns#

WorkflowClientOptionsWithDefaults