cap-nodejs

CAP Node.js API


CAP Node.js API / cap-core/src / ReceivedStoragePort

Interface: ReceivedStoragePort

Defined in: cap-core/src/ports/received-storage.port.ts:23

Methods

findReceivedById()?

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

Defined in: cap-core/src/ports/received-storage.port.ts:40

Parameters

id

string

Returns

Promise<CapReceivedEvent<JsonValue> | undefined>


getRetryDue()

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

Defined in: cap-core/src/ports/received-storage.port.ts:32

Parameters

limit

number

now?

Date

Returns

Promise<CapReceivedEvent<JsonValue>[]>


initialize()?

optional initialize(options?): Promise<void>

Defined in: cap-core/src/ports/received-storage.port.ts:28

Parameters

options?

InitOptions

Returns

Promise<void>


listReceived()?

optional listReceived(options): Promise<DashboardListResult<CapReceivedEvent<JsonValue>>>

Defined in: cap-core/src/ports/received-storage.port.ts:42

Parameters

options

DashboardListOptions

Returns

Promise<DashboardListResult<CapReceivedEvent<JsonValue>>>


markProcessed()

markProcessed(id, processedAt?): Promise<void>

Defined in: cap-core/src/ports/received-storage.port.ts:30

Parameters

id

string

processedAt?

Date

Returns

Promise<void>


markReceivedFailed()

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

Defined in: cap-core/src/ports/received-storage.port.ts:34

Parameters

id

string

error

unknown

options

MarkReceivedFailedOptions

Returns

Promise<void>


trySaveReceived()

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

Defined in: cap-core/src/ports/received-storage.port.ts:24

Type Parameters

T

T extends JsonValue = JsonValue

Parameters

event

CapReceivedEvent<T>

Returns

Promise<TrySaveReceivedResult<T>>