Skip to main content

Class: AsyncCompletionClient

client.AsyncCompletionClient

A client for asynchronous completion and heartbeating of Activities.

Typically this client should not be instantiated directly, instead create the high level Client and use Client.activity to complete async activities.

Hierarchy

  • BaseClient

    AsyncCompletionClient

Constructors

constructor

new AsyncCompletionClient(options?): AsyncCompletionClient

Parameters

NameType
options?BaseClientOptions

Returns

AsyncCompletionClient

Overrides

BaseClient.constructor

Properties

connection

Readonly connection: ConnectionLike

Inherited from

BaseClient.connection


options

Readonly options: LoadedAsyncCompletionClientOptions

Accessors

workflowService

get workflowService(): WorkflowService

Raw gRPC access to the Temporal service.

NOTE: The namespace provided in options is not automatically set on requests made via this service object.

Returns

WorkflowService

Methods

complete

complete(taskToken, result): Promise<void>

Complete an Activity by task token

Parameters

NameType
taskTokenUint8Array
resultunknown

Returns

Promise<void>

complete(fullActivityId, result): Promise<void>

Complete an Activity by full ID

Parameters

NameType
fullActivityIdFullActivityId
resultunknown

Returns

Promise<void>


fail

fail(taskToken, err): Promise<void>

Fail an Activity by task token

Parameters

NameType
taskTokenUint8Array
errunknown

Returns

Promise<void>

fail(fullActivityId, err): Promise<void>

Fail an Activity by full ID

Parameters

NameType
fullActivityIdFullActivityId
errunknown

Returns

Promise<void>


heartbeat

heartbeat(taskToken, details?): Promise<void>

Send Activity heartbeat by task token

Parameters

NameType
taskTokenUint8Array
details?unknown

Returns

Promise<void>

heartbeat(fullActivityId, details?): Promise<void>

Send Activity heartbeat by full ID

Parameters

NameType
fullActivityIdFullActivityId
details?unknown

Returns

Promise<void>


reportCancellation

reportCancellation(taskToken, details?): Promise<void>

Report Activity cancellation by task token

Parameters

NameType
taskTokenUint8Array
details?unknown

Returns

Promise<void>

reportCancellation(fullActivityId, details?): Promise<void>

Report Activity cancellation by full ID

Parameters

NameType
fullActivityIdFullActivityId
details?unknown

Returns

Promise<void>


withAbortSignal

withAbortSignal<R>(abortSignal, fn): Promise<R>

Set an AbortSignal that, when aborted, cancels any ongoing service requests executed in fn's scope.

Type parameters

Name
R

Parameters

NameType
abortSignalAbortSignal
fn() => Promise<R>

Returns

Promise<R>

value returned from fn

See

Connection.withAbortSignal

Inherited from

BaseClient.withAbortSignal


withDeadline

withDeadline<R>(deadline, fn): Promise<R>

Set the deadline for any service requests executed in fn's scope.

Type parameters

Name
R

Parameters

NameType
deadlinenumber | Date
fn() => Promise<R>

Returns

Promise<R>

Inherited from

BaseClient.withDeadline


withMetadata

withMetadata<R>(metadata, fn): Promise<R>

Set metadata for any service requests executed in fn's scope.

Type parameters

Name
R

Parameters

NameType
metadataMetadata
fn() => Promise<R>

Returns

Promise<R>

returned value of fn

See

Connection.withMetadata

Inherited from

BaseClient.withMetadata