Interface: ConnectionLike
client.ConnectionLike
Connection interface used by high level SDK clients.
NOTE: Currently the SDK only supports grpc-js based connection but in the future we might support grpc-web and native Rust connections.
Properties
workflowService
• workflowService: WorkflowService
Methods
close
▸ close(): Promise<void>
Returns
Promise<void>
ensureConnected
▸ ensureConnected(): Promise<void>
Returns
Promise<void>
withAbortSignal
▸ withAbortSignal<R>(abortSignal, fn): Promise<R>
Set an AbortSignal that, when aborted,
cancels any ongoing requests executed in fn's scope.
Type parameters
| Name |
|---|
R |
Parameters
| Name | Type |
|---|---|
abortSignal | AbortSignal |
fn | () => Promise<R> |
Returns
Promise<R>
value returned from fn
withDeadline
▸ withDeadline<R>(deadline, fn): Promise<R>
Set the deadline for any service requests executed in fn's scope.
Type parameters
| Name |
|---|
R |
Parameters
| Name | Type |
|---|---|
deadline | number | Date |
fn | () => Promise<R> |
Returns
Promise<R>
withMetadata
▸ withMetadata<R>(metadata, fn): Promise<R>
Set metadata for any service requests executed in fn's scope.
Type parameters
| Name |
|---|
R |
Parameters
| Name | Type |
|---|---|
metadata | Metadata |
fn | () => Promise<R> |
Returns
Promise<R>
returned value of fn