Documents for @litert/idempotency / MemoryStorageAdapter / IdempotencyMemoryStorageAdapter
Class: IdempotencyMemoryStorageAdapter
Defined in: src/lib/MemoryStorageAdapter.ts:39
A simple in-memory storage adapter for idempotent records.
This adapter stores records in memory and supports the TTL (Time To Live) feature, but it does not persist data across application restarts.
It is only for testing and development purposes. For production use, consider using a persistent storage solution, like Redis or a database (MongoDB, MySQL, PgSQL, or others).
However, if you insist on using this in production, please ensure that you have sufficient memory and that the application is designed to handle potential data loss on restarts. Besides, you must create a timer to periodically call the gc method to clean up expired records.
Implements
Constructors
Constructor
new IdempotencyMemoryStorageAdapter(
ttlMs):IdempotencyMemoryStorageAdapter
Defined in: src/lib/MemoryStorageAdapter.ts:45
Parameters
ttlMs
number
Returns
IdempotencyMemoryStorageAdapter
Methods
create()
create(
data):Promise<boolean>
Defined in: src/lib/MemoryStorageAdapter.ts:50
Create a new idempotency record in the storage.
This method must be atomic, and it should not allow overwriting an existing record.
Parameters
data
The idempotency record to create.
Returns
Promise<boolean>
A promise that resolves to true if the record was created successfully, false if it already exists.
Implementation of
gc()
gc():
void
Defined in: src/lib/MemoryStorageAdapter.ts:104
Clean up expired records.
Returns
void
get()
get(
key):Promise<null|IStoredRecord>
Defined in: src/lib/MemoryStorageAdapter.ts:65
Retrieve an idempotency record by its key from the storage.
Parameters
key
string
The unique key for this operation, used to ensure idempotency.
Returns
Promise<null | IStoredRecord>
Implementation of
update()
update(
data):Promise<void>
Defined in: src/lib/MemoryStorageAdapter.ts:88
Update the idempotency record in the storage, from PENDING to SUCCESS or FAILED.
Parameters
data
Omit<IStoredRecord, "context">
The idempotency record to update.
Returns
Promise<void>