Skip to main content

Interface: TemporalCancelOperationContext

Experimental

Context received by a TemporalOperationHandler's cancel handler when a Nexus Operation is canceled.

Temporal Operation handlers are experimental.

Extends​

  • CancelOperationContext

Properties​

abortSignal​

readonly abortSignal: AbortSignal

Experimental

An AbortSignal that is signaled when the current request is canceled, e.g. because the request timed out or the client disconnected.

The framework will cancel the abort controller with an unspecified error type. The handler must rethrow the error object to confirm cancelation. The handler may ignore cancelation and return a result anyway, but there is no guarantee that the client will still be waiting for the result of that request.

Note that cancelation of the current request is not the same thing - and does not relate with - cancelation of the operation itself, which is notified by calling the OperationHandler.cancel method.

Inherited from​

nexus.CancelOperationContext.abortSignal

headers​

readonly headers: Record<string, string>

Experimental

Request header fields.

Inherited from​

nexus.CancelOperationContext.headers

operation​

readonly operation: string

Experimental

Name of the operation.

Inherited from​

nexus.CancelOperationContext.operation

requestDeadline?​

readonly optional requestDeadline?: Date

Experimental

Get the deadline for the operation handler method.

Note that this is the time by which the current request should complete, not the operation's deadline.

Inherited from​

nexus.CancelOperationContext.requestDeadline

service​

readonly service: string

Experimental

Name of the service that contains the operation.

Inherited from​

nexus.CancelOperationContext.service