Interface: NexusOperationHandle<O>
client.NexusOperationHandle
Handle to a standalone Nexus operation execution.
Use this to poll for results, describe, cancel, or terminate the operation.
Nexus Standalone Operations are experimental.
Type parameters
| Name | Type |
|---|---|
O | unknown |
Properties
client
• Readonly client: NexusClient
operationId
• Readonly operationId: string
runId
• Optional Readonly runId: string
Methods
cancel
▸ cancel(reason?): Promise<void>
Request cancellation of the operation.
Parameters
| Name | Type | Description |
|---|---|---|
reason? | string | optional reason for the cancellation. Nexus Standalone Operations are experimental. |
Returns
Promise<void>
describe
▸ describe(options?): Promise<NexusOperationExecutionDescription>
Describe the Nexus operation execution.
Nexus Standalone Operations are experimental.
Parameters
| Name | Type |
|---|---|
options? | DescribeNexusOperationOptions |
Returns
Promise<NexusOperationExecutionDescription>
result
▸ result(): Promise<O>
Wait for the operation to complete and return its result.
Returns
Promise<O>
Throws
NexusOperationFailureError if the operation completes with a failure outcome.
Nexus Standalone Operations are experimental.
terminate
▸ terminate(reason?): Promise<void>
Terminate the Nexus operation execution immediately.
Nexus Standalone Operations are experimental.
Parameters
| Name | Type |
|---|---|
reason? | string |
Returns
Promise<void>