Skip to main content
Defined in: durability/journal.ts:88 InboxJournal over a DurableKv.

Implements

Constructors

Constructor

Defined in: durability/journal.ts:90

Parameters

Returns

KvInbox

Methods

append()

Defined in: durability/journal.ts:96 Insert-if-absent by id. 'duplicate' means the id is already known (any state); the existing record is returned unchanged. With lease, a new record is created already claimed (processing, token 1, 1 attempt), so no other claimer can take it between the append and the claim.

Parameters

Returns

Promise<{ status: "appended" | "duplicate"; record: InboxRecord; }>

Implementation of

InboxJournal.append

claim()

Defined in: durability/journal.ts:115 Lease due records: pending/failed whose nextAttemptAt <= now, plus processing records whose lease expired. Oldest receivedAt first. Each claimed record comes back processing with a fresh fencingToken and attempts + 1.

Parameters

Returns

Promise<InboxRecord[]>

Implementation of

InboxJournal.claim

claimOne()

Defined in: durability/journal.ts:138 Lease one specific record when it is claimable (as claim); null when it is not.

Parameters

Returns

Promise<InboxRecord | null>

Implementation of

InboxJournal.claimOne

ack()

Defined in: durability/journal.ts:154 processing → done.

Parameters

Returns

Promise<void>

Throws

when token is not the current claim.

Implementation of

InboxJournal.ack

fail()

Defined in: durability/journal.ts:158 processing → failed (due at retryAt, default now) or dead (dead: true).

Parameters

Returns

Promise<void>

Throws

Implementation of

InboxJournal.fail

release()

Defined in: durability/journal.ts:164 processing → pending, due now; the claim’s attempt is not charged.

Parameters

Returns

Promise<void>

Throws

Implementation of

InboxJournal.release

extend()

Defined in: durability/journal.ts:168 Extend the current lease (heartbeat).

Parameters

Returns

Promise<void>

Throws

Implementation of

InboxJournal.extend

replay()

Defined in: durability/journal.ts:172 Operator replay: any record → pending, due now, attempts reset. No-op for an unknown id.

Parameters

Returns

Promise<void>

Implementation of

InboxJournal.replay

get()

Defined in: durability/journal.ts:178

Parameters

Returns

Promise<InboxRecord | undefined>

Implementation of

InboxJournal.get

list()

Defined in: durability/journal.ts:183 Records, optionally by state, oldest receivedAt first.

Parameters

Returns

Promise<InboxRecord[]>

Implementation of

InboxJournal.list

purge()

Defined in: durability/journal.ts:189 Delete done records completed before doneBefore (and dead ones when includeDead). Returns the count.

Parameters

Returns

Promise<number>

Implementation of

InboxJournal.purge