cap-nodejs

CAP Node.js API


CAP Node.js API / cap-nest/src / IReceivedStorage

Interface: IReceivedStorage

Defined in: cap-nest/src/cap/abstractions/storage.interface.ts:118

Methods

findReceivedById()?

optional findReceivedById(id): Promise<CapReceivedEvent<JsonValue> | undefined>

Defined in: cap-nest/src/cap/abstractions/storage.interface.ts:147

Optional: find a received record by id (dashboard helpers)

Parameters

id

string

Returns

Promise<CapReceivedEvent<JsonValue> | undefined>


getRetryDue()

getRetryDue(limit): Promise<CapReceivedEvent<JsonValue>[]>

Defined in: cap-nest/src/cap/abstractions/storage.interface.ts:137

Return records that are not yet processed and whose nextRetry timestamp <= now. Scheduler uses this.

Parameters

limit

number

Returns

Promise<CapReceivedEvent<JsonValue>[]>


initialize()?

optional initialize(options?): Promise<void>

Defined in: cap-nest/src/cap/abstractions/storage.interface.ts:128

Optional one-time initialization: create schema/tables if needed

Parameters

options?

InitOptions

Returns

Promise<void>


listReceived()?

optional listReceived(opts): Promise<{ items: CapReceivedEvent<JsonValue>[]; total?: number; }>

Defined in: cap-nest/src/cap/abstractions/storage.interface.ts:150

Optional: paginated listing for dashboards and admin UIs

Parameters

opts
due?

boolean

limit?

number

offset?

number

topic?

string

Returns

Promise<{ items: CapReceivedEvent<JsonValue>[]; total?: number; }>


markProcessed()

markProcessed(id): Promise<void>

Defined in: cap-nest/src/cap/abstractions/storage.interface.ts:131

Mark processed=true

Parameters

id

string

Returns

Promise<void>


markReceivedFailed()

markReceivedFailed(id, error, options): Promise<void>

Defined in: cap-nest/src/cap/abstractions/storage.interface.ts:140

Mark inbox processing failed, or dead-letter when retry limit is exceeded.

Parameters

id

string

error

unknown

options

MarkReceivedFailedOptions

Returns

Promise<void>


trySaveReceived()

trySaveReceived<T>(evt): Promise<TrySaveReceivedResult<T>>

Defined in: cap-nest/src/cap/abstractions/storage.interface.ts:123

Persist a delivery if its dedupe identity has not been seen. Duplicate deliveries return inserted=false and must not re-run handlers.

Type Parameters

T

T extends JsonValue = JsonValue

Parameters

evt

CapReceivedEvent<T>

Returns

Promise<TrySaveReceivedResult<T>>