Interface ITransportConsumer<TPayload>

interface ITransportConsumer<TPayload extends WorkJson = WorkJson> {
    AcknowledgeCancel(
        delivery: ReceivedDelivery<TPayload>,
    ): Promise<SettleResult>;
    Close(): Promise<void>;
    Complete(delivery: ReceivedDelivery<TPayload>): Promise<SettleResult>;
    DeadLetter(
        delivery: ReceivedDelivery<TPayload>,
        reason: string,
        error: string | null,
    ): Promise<SettleResult>;
    ExtendLease(
        delivery: ReceivedDelivery<TPayload>,
        leaseSeconds: number,
        progress?: WorkProgress,
    ): Promise<LeaseExtension>;
    Receive(
        max: number,
        waitSeconds: number,
        signal: AbortSignal,
    ): Promise<ReceivedDelivery<TPayload>[]>;
    Release(delivery: ReceivedDelivery<TPayload>): Promise<SettleResult>;
    Retry(
        delivery: ReceivedDelivery<TPayload>,
        delaySeconds: number,
        error: string,
    ): Promise<SettleResult>;
}

Type Parameters

TPayload extends WorkJson = WorkJson

Implemented by

Index

Methods

AcknowledgeCancel Close Complete DeadLetter ExtendLease Receive Release Retry

Methods

AcknowledgeCancel

AcknowledgeCancel(delivery: ReceivedDelivery<TPayload>): Promise<SettleResult>
Token-fenced: a cancelled InFlight delivery held by this token → Discarded now, freeing its key (spec 03 §7). Anything else → LeaseLost with no change. Transports without CancelInFlight always return LeaseLost.
Parameters
- delivery: ReceivedDelivery<TPayload>
Returns Promise<SettleResult>
- Defined in packages/WorkQueue/core/src/transport.ts:102

Close

Close(): Promise<void>
Releases the consumer's independent executor / clients (spec 03 §11).

Returns Promise<void>
- Defined in packages/WorkQueue/core/src/transport.ts:104

Complete

Complete(delivery: ReceivedDelivery<TPayload>): Promise<SettleResult>
Parameters
- delivery: ReceivedDelivery<TPayload>
Returns Promise<SettleResult>
- Defined in packages/WorkQueue/core/src/transport.ts:93

DeadLetter

DeadLetter(
    delivery: ReceivedDelivery<TPayload>,
    reason: string,
    error: string | null,
): Promise<SettleResult>
Parameters
- delivery: ReceivedDelivery<TPayload>
- reason: string
- error: string | null
Returns Promise<SettleResult>
- Defined in packages/WorkQueue/core/src/transport.ts:95

ExtendLease

ExtendLease(
    delivery: ReceivedDelivery<TPayload>,
    leaseSeconds: number,
    progress?: WorkProgress,
): Promise<LeaseExtension>
A thrown error is transient (the runtime retries next tick). 'Cancelled' only where CancelInFlight.
Parameters
- delivery: ReceivedDelivery<TPayload>
- leaseSeconds: number
- Optionalprogress: WorkProgress
Returns Promise<LeaseExtension>
- Defined in packages/WorkQueue/core/src/transport.ts:92

Receive

Receive(
    max: number,
    waitSeconds: number,
    signal: AbortSignal,
): Promise<ReceivedDelivery<TPayload>[]>
Never returns two deliveries of one partition key for a partitioned subscription (spec 03 §7).
Parameters
- max: number
- waitSeconds: number
- signal: AbortSignal
Returns Promise<ReceivedDelivery<TPayload>[]>
- Defined in packages/WorkQueue/core/src/transport.ts:90

Release

Release(delivery: ReceivedDelivery<TPayload>): Promise<SettleResult>
Database: no attempt consumed. SQS: the receive is already counted (spec 03 §5.1).
Parameters
- delivery: ReceivedDelivery<TPayload>
Returns Promise<SettleResult>
- Defined in packages/WorkQueue/core/src/transport.ts:97

Retry

Retry(
    delivery: ReceivedDelivery<TPayload>,
    delaySeconds: number,
    error: string,
): Promise<SettleResult>
Parameters
- delivery: ReceivedDelivery<TPayload>
- delaySeconds: number
- error: string
Returns Promise<SettleResult>
- Defined in packages/WorkQueue/core/src/transport.ts:94