InboxJournal

Interface exported by @botmesh/core/spi.

Defined in: durability/types.ts:137

Persistence contract of the inbound journal.

Methods

append()

append(
   record, 
   now, 
   lease?
): Promise<{
  status: "appended" | "duplicate";
  record: InboxRecord;
}>;

Defined in: durability/types.ts:144

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

Parameter	Type
record	InboxAppend
now	number
lease?	LeaseOptions

Returns

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

---

claim()

claim(options): Promise<InboxRecord[]>;

Defined in: durability/types.ts:150

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

Parameter	Type
options	ClaimOptions

Returns

Promise<InboxRecord[]>

---

claimOne()

claimOne(id, options): Promise<InboxRecord | null>;

Defined in: durability/types.ts:152

Lease one specific record when it is claimable (as claim); null when it is not.

Parameters

Parameter	Type
id	string
options	LeaseOptions

Returns

Promise<InboxRecord | null>

---

ack()

ack(
   id, 
   token, 
   now
): Promise<void>;

Defined in: durability/types.ts:154

processing → done.

Parameters

Parameter	Type
id	string
token	number
now	number

Returns

Promise<void>

Throws

when token is not the current claim.

---

fail()

fail(
   id, 
   token, 
   error, 
   options
): Promise<void>;

Defined in: durability/types.ts:159

processing → failed (due at retryAt, default now) or dead (dead: true).

Parameters

Parameter	Type
id	string
token	number
error	string
options	{ now: number; retryAt?: number; dead?: boolean; }
options.now	number
options.retryAt?	number
options.dead?	boolean

Returns

Promise<void>

Throws

---

release()

release(
   id, 
   token, 
   now
): Promise<void>;

Defined in: durability/types.ts:161

processing → pending, due now; the claim’s attempt is not charged.

Parameters

Parameter	Type
id	string
token	number
now	number

Returns

Promise<void>

Throws

---

extend()

extend(
   id, 
   token, 
   leaseUntil
): Promise<void>;

Defined in: durability/types.ts:163

Extend the current lease (heartbeat).

Parameters

Parameter	Type
id	string
token	number
leaseUntil	number

Returns

Promise<void>

Throws

---

replay()

replay(id, now): Promise<void>;

Defined in: durability/types.ts:165

Operator replay: any record → pending, due now, attempts reset. No-op for an unknown id.

Parameters

Parameter	Type
id	string
now	number

Returns

Promise<void>

---

get()

get(id): Promise<InboxRecord | undefined>;

Defined in: durability/types.ts:166

Parameters

Parameter	Type
id	string

Returns

Promise<InboxRecord | undefined>

---

list()

list(filter?): Promise<InboxRecord[]>;

Defined in: durability/types.ts:168

Records, optionally by state, oldest receivedAt first.

Parameters

Parameter	Type
filter?	{ state?: InboxState; limit?: number; }
filter.state?	InboxState
filter.limit?	number

Returns

Promise<InboxRecord[]>

---

purge()

purge(options): Promise<number>;

Defined in: durability/types.ts:170

Delete done records completed before doneBefore (and dead ones when includeDead). Returns the count.

Parameters

Parameter	Type
options	{ doneBefore: number; includeDead?: boolean; }
options.doneBefore	number
options.includeDead?	boolean

Returns

Promise<number>