Interface: NexusOperationHandle<O>
Experimental
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
O
O = unknown
Properties
client
readonlyclient:NexusClient
Experimental
operationId
readonlyoperationId:string
Experimental
runId?
readonlyoptionalrunId?:string
Experimental
Methods
cancel()
cancel(
reason?):Promise<void>
Experimental
Request cancellation of the operation.
Parameters
reason?
string
optional reason for the cancellation.
Nexus Standalone Operations are experimental.
Returns
Promise<void>
describe()
describe(
options?):Promise<NexusOperationExecutionDescription>
Experimental
Describe the Nexus operation execution.
Nexus Standalone Operations are experimental.
Parameters
options?
Returns
Promise<NexusOperationExecutionDescription>
result()
result():
Promise<O>
Experimental
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>
Experimental
Terminate the Nexus operation execution immediately.
Nexus Standalone Operations are experimental.
Parameters
reason?
string
Returns
Promise<void>