Skip to main content

Class: Client

client.Client

High level SDK client.

Hierarchy​

  • BaseClient

    ↳ Client

Constructors​

constructor​

• new Client(options?): Client

Parameters​

NameType
options?ClientOptions

Returns​

Client

Overrides​

BaseClient.constructor

Properties​

activity​

• Readonly activity: AsyncCompletionClient

(Async) Activity completion sub-client - use to manually manage Activities

connection​

• Readonly connection: ConnectionLike

Inherited from​

BaseClient.connection

options​

• Readonly options: LoadedClientOptions

schedule​

• Readonly schedule: ScheduleClient

Schedule sub-client - use to start and interact with Schedules

taskQueue​

• Readonly taskQueue: TaskQueueClient

Task Queue sub-client - use to perform operations on Task Queues

workflow​

• Readonly workflow: WorkflowClient

Workflow sub-client - use to start and interact with Workflows

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​

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