Skip to main content

Interface: TemporalStartOperationContext

nexus.TemporalStartOperationContext

Context received by a TemporalOperationHandler's start handler when a Nexus Operation is started.

Temporal Operation handlers are experimental.

Hierarchy​

  • StartOperationContext

    ↳ TemporalStartOperationContext

Properties​

abortSignal​

• Readonly abortSignal: AbortSignal

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.StartOperationContext.abortSignal

callbackHeaders​

• Optional Readonly callbackHeaders: Record<string, string>

Optional header fields set by a client that are required to be attached to the callback request when an asynchronous operation completes.

Inherited from​

nexus.StartOperationContext.callbackHeaders

callbackUrl​

• Optional Readonly callbackUrl: string

Callbacks are used to deliver completion of async operations.

A callback URL may optionally be provided by the client and should be called by this handler upon completion if the started operation is async.

Inherited from​

nexus.StartOperationContext.callbackUrl

headers​

• Readonly headers: Record<string, string>

Request header fields.

Inherited from​

nexus.StartOperationContext.headers

• Readonly inboundLinks: Link[]

Links received in the request.

This list is automatically populated when handling a start request. Handlers may use these links, for example to add information about the caller to a resource associated with the operation execution.

Inherited from​

nexus.StartOperationContext.inboundLinks

operation​

• Readonly operation: string

Name of the operation.

Inherited from​

nexus.StartOperationContext.operation

• Readonly outboundLinks: Link[]

Links to be returned by the handler.

This list is initially empty. Handlers may add to this list, for example links describing resources associated with the operation execution that may be of use to the caller.

Inherited from​

nexus.StartOperationContext.outboundLinks

requestDeadline​

• Optional Readonly requestDeadline: Date

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.StartOperationContext.requestDeadline

requestId​

• Readonly requestId: string

Request ID that may be used by the server handler to dedupe a start request. By default a v4 UUID will be generated by the client.

Inherited from​

nexus.StartOperationContext.requestId

service​

• Readonly service: string

Name of the service that contains the operation.

Inherited from​

nexus.StartOperationContext.service