Interface OutboxStore

Durable storage of outbox entries.

interface OutboxStore {
    add(entry: OutboxEntry): Promise<OutboxEntry>;
    close(): Promise<void>;
    failed(): Promise<OutboxEntry[]>;
    mark(
        entryId: number,
        state: OutboxState,
        problemCode?: string,
    ): Promise<void>;
    pending(): Promise<OutboxEntry[]>;
}

Implemented by

Index

Methods

add close failed mark pending

Methods

add

add(entry: OutboxEntry): Promise<OutboxEntry>
Stores a new entry durably before it is sent.
Parameters
- entry: OutboxEntry
  The entry; its entryId is ignored.
Returns Promise<OutboxEntry>
The entry with its entryId.

Throws
Error when an entry with the same key is already stored.

close

close(): Promise<void>
Releases the storage after the operations in flight.

Returns Promise<void>

failed

failed(): Promise<OutboxEntry[]>
Returns every failed entry.

Returns Promise<OutboxEntry[]>
The failed entries in entryId order.

mark

mark(entryId: number, state: OutboxState, problemCode?: string): Promise<void>
Changes the state of an entry; sent deletes it.
Parameters
- entryId: number
  The entry.
- state: OutboxState
  The new state.
- OptionalproblemCode: string
  The problem code of a failed entry.
Returns Promise<void>

pending

pending(): Promise<OutboxEntry[]>
Returns every pending entry.

Returns Promise<OutboxEntry[]>
The pending entries in entryId order.