Skip to main content

Class: Connection

client.Connection

Client connection to the Temporal Service

Constructors#

constructor#

new Connection(options?)

Parameters#

NameType
options?ConnectionOptions

Properties#

client#

Readonly client: Client


options#

Readonly options: Required<Omit<ConnectionOptions, "tls">>


service#

Readonly service: WorkflowService

Raw gRPC access to the Temporal service.

NOTE: The namespace provided in options is not automatically set on requests made to the service.


Client#

Static Readonly Client: ServiceClientConstructor

Methods#

untilReady#

untilReady(waitTimeMs?): Promise<void>

Wait for successful connection to the server.

see https://grpc.github.io/grpc/node/grpc.Client.html#waitForReady__anchor

Parameters#

NameTypeDescription
waitTimeMs?numbermilliseconds to wait before giving up.

Returns#

Promise<void>