Class KvOutbox

OutboxJournal over a DurableKv.

Implements

OutboxJournal

Index

Constructors

constructor

Methods

put begin markSent extend markFailed claimDue resolveAmbiguous get list retry discard purge

Constructors

constructor

new KvOutbox(kv: DurableKv, table?: string): KvOutbox
Parameters
- kv: DurableKv
- table: string = 'outbox'
  The KV table ('outbox', or 'outbox:<scope>' for a scoped view).
Returns KvOutbox
- Defined in durability/journal.ts:226

Methods

put

put(
    input: OutboxPut,
    now: number,
    lease?: LeaseOptions,
): Promise<{ status: "created" | "exists"; record: OutboxRecord }>
Insert-if-absent by key; on conflict the existing record is returned unchanged ('exists'). With lease, a new record is created already begun (sending, token 1, 1 attempt).
Parameters
- input: OutboxPut
- now: number
- Optionallease: LeaseOptions
Returns Promise<{ status: "created" | "exists"; record: OutboxRecord }>
Implementation of OutboxJournal.put
- Defined in durability/journal.ts:232

begin

begin(key: string, o: LeaseOptions): Promise<OutboxRecord | null>
pending/failed (due or not) → sending under a fresh token: the persisted "about to call the provider" marker. null when the record is missing or in another state.
Parameters
- key: string
- o: LeaseOptions
Returns Promise<OutboxRecord | null>
Implementation of OutboxJournal.begin
- Defined in durability/journal.ts:254

markSent

markSent(
    key: string,
    token: number,
    result: { ref: MessageRef },
    now: number,
): Promise<void>
sending → sent with the provider ref.
Parameters
- key: string
- token: number
- result: { ref: MessageRef }
- now: number
Returns Promise<void>

Throws
Implementation of OutboxJournal.markSent
- Defined in durability/journal.ts:268

extend

extend(key: string, token: number, leaseUntil: number): Promise<void>
Extend the lease of a sending record (heartbeat while the provider call runs).
Parameters
- key: string
- token: number
- leaseUntil: number
Returns Promise<void>

Throws
Implementation of OutboxJournal.extend
- Defined in durability/journal.ts:272

markFailed

markFailed(
    key: string,
    token: number,
    error: OutboxError,
    o: { now: number; retryAt?: number; dead?: boolean; refund?: boolean },
): Promise<void>
sending → failed (due at retryAt) or dead. With refund, the claim made no provider call (a split part deferred behind an earlier one): the attempt it counted is given back, so waiting never uses up the record's retries.
Parameters
- key: string
- token: number
- error: OutboxError
- o: { now: number; retryAt?: number; dead?: boolean; refund?: boolean }
Returns Promise<void>

Throws
Implementation of OutboxJournal.markFailed
- Defined in durability/journal.ts:276

claimDue

claimDue(o: OutboxClaimOptions): Promise<ClaimedSend[]>
Lease due pending/failed records and sending records whose lease expired (returned with ambiguous: true), oldest createdAt first. Claimed records come back sending under a fresh token.
Parameters
- o: OutboxClaimOptions
Returns Promise<ClaimedSend[]>
Implementation of OutboxJournal.claimDue
- Defined in durability/journal.ts:285

resolveAmbiguous

resolveAmbiguous(
    key: string,
    token: number,
    to: "unknown" | "pending",
    now: number,
): Promise<void>
Settle an ambiguous claim: 'unknown' (terminal) or 'pending' (send again).
Parameters
- key: string
- token: number
- to: "unknown" | "pending"
- now: number
Returns Promise<void>

Throws
Implementation of OutboxJournal.resolveAmbiguous
- Defined in durability/journal.ts:312

get

get(key: string): Promise<OutboxRecord | undefined>
Parameters
- key: string
Returns Promise<OutboxRecord | undefined>
Implementation of OutboxJournal.get
- Defined in durability/journal.ts:318

list

list(
filter?: { state?: OutboxState; chatId?: string; limit?: number },
): Promise<OutboxRecord[]>
Records, optionally by state and chat, oldest createdAt first.
Parameters
- filter: { state?: OutboxState; chatId?: string; limit?: number } = {}
Returns Promise<OutboxRecord[]>
Implementation of OutboxJournal.list
- Defined in durability/journal.ts:323

retry

retry(key: string, now: number): Promise<void>
Operator retry: failed/dead/unknown → pending, due now.
Parameters
- key: string
- now: number
Returns Promise<void>
Implementation of OutboxJournal.retry
- Defined in durability/journal.ts:330

discard

discard(key: string): Promise<void>
Operator discard: delete the record (a later send with the same key goes out again).
Parameters
- key: string
Returns Promise<void>
Implementation of OutboxJournal.discard
- Defined in durability/journal.ts:336

purge

purge(o: { before: number }): Promise<number>
Delete terminal records completed before before. Returns the count.
Parameters
- o: { before: number }
Returns Promise<number>
Implementation of OutboxJournal.purge
- Defined in durability/journal.ts:343

Class KvOutbox

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns KvOutbox

Methods

put

Parameters

Returns Promise<{ status: "created" | "exists"; record: OutboxRecord }>

begin

Parameters

Returns Promise<OutboxRecord | null>

markSent

Parameters

Returns Promise<void>

Throws

extend

Parameters

Returns Promise<void>

Throws

markFailed

Parameters

Returns Promise<void>

Throws

claimDue

Parameters

Returns Promise<ClaimedSend[]>

resolveAmbiguous

Parameters

Returns Promise<void>

Throws

get

Parameters

Returns Promise<OutboxRecord | undefined>

list

Parameters

Returns Promise<OutboxRecord[]>

retry

Parameters

Returns Promise<void>

discard

Parameters

Returns Promise<void>

purge

Parameters

Returns Promise<number>

Settings

On This Page