Interface WorkContext

interface WorkContext {
    Attempt: number;
    DeliveryID: string;
    IsReplay: boolean;
    Log: WorkLogger;
    MaxAttempts: number;
    Signal: AbortSignal;
    SubscriptionName: string;
    Heartbeat(progress?: WorkProgress): Promise<boolean>;
}

Index

Properties

Attempt DeliveryID IsReplay Log MaxAttempts Signal SubscriptionName

Methods

Properties

`Readonly`Attempt

Attempt: number

1-based

`Readonly`DeliveryID

DeliveryID: string

Database: WorkQueueDelivery.ID; SQS: SQS MessageId

`Readonly`IsReplay

IsReplay: boolean

`Readonly`Log

Log: WorkLogger

`Readonly`MaxAttempts

MaxAttempts: number

`Readonly`Signal

Signal: AbortSignal

Aborted with a WorkAbortReason when an operator cancels, the lease is lost, the cap is hit, or the host stops.

`Readonly`SubscriptionName

SubscriptionName: string

Methods

Heartbeat

Heartbeat(progress?: WorkProgress): Promise<boolean>
Renews the lease and records progress. Resolves false once the lease is lost or the delivery is cancelled (spec 03 §7); the handler must stop. A transient transport failure does not resolve false: it is retried on the next tick while the lease horizon has not passed.
Parameters
- Optionalprogress: WorkProgress
Returns Promise<boolean>
- Defined in packages/WorkQueue/core/src/handler.ts:36