Type Alias OutboxStorage

Durable storage for the outbox queue. All methods may be sync or async — the outbox awaits them either way. load() returns null when nothing is persisted (or the backing store is unavailable, e.g. SSR).

type OutboxStorage = {
    load(): OutboxRecord[] | Promise<OutboxRecord[] | null> | null;
    save(records: OutboxRecord[]): void | Promise<void>;
    clear(): void | Promise<void>;
}

Index

Methods

load save clear

Methods

load

load(): OutboxRecord[] | Promise<OutboxRecord[] | null> | null
Returns OutboxRecord[] | Promise<OutboxRecord[] | null> | null
- Defined in outbox.ts:67

save

save(records: OutboxRecord[]): void | Promise<void>
Parameters
- records: OutboxRecord[]
Returns void | Promise<void>
- Defined in outbox.ts:68

clear

clear(): void | Promise<void>
Returns void | Promise<void>
- Defined in outbox.ts:69