Class MemoryStorage<T>

In-memory storage implementation with TTL support

This is the default storage used when no external storage is configured. Features:

TTL support with automatic cleanup
Pattern matching
Batch operations
Memory-efficient (garbage collection of expired items)

Example

const storage = new MemoryStorage<string>();
await storage.set('key', 'value', 60); // TTL of 60 seconds
const value = await storage.get('key');

Type Parameters

Implements

Constructors

constructor

new MemoryStorage<T>(
    options?: {
        cleanupIntervalMs?: number;
        maxItems?: number;
        autoCleanup?: boolean;
    },
): MemoryStorage<T>
Type Parameters
- T
Parameters
- options: { cleanupIntervalMs?: number; maxItems?: number; autoCleanup?: boolean } = {}
  - OptionalcleanupIntervalMs?: number
    
    How often to clean up expired items (ms), default 5 minutes
  - OptionalmaxItems?: number
    
    Maximum items to store before forcing cleanup, default 10000
  - OptionalautoCleanup?: boolean
    
    Whether to enable automatic cleanup, default true
Returns MemoryStorage<T>
- Defined in src/lib/storage/MemoryStorage.ts:38

Methods

get

get(key: string): Promise<T | undefined>
Get a value by key
Parameters
- key: string
  Storage key
Returns Promise<T | undefined>
Value or undefined if not found
Implementation of PatternStorage.get
- Defined in src/lib/storage/MemoryStorage.ts:60

take

take(key: string): Promise<T | undefined>
Parameters
- key: string
Returns Promise<T | undefined>
Implementation of AtomicTakeStorage.take
- Defined in src/lib/storage/MemoryStorage.ts:77

putIfAbsent

putIfAbsent(key: string, value: T, ttl?: number): Promise<boolean>
Atomically create a value only when the key is absent or expired.
Parameters
- key: string
- value: T
- Optionalttl: number
Returns Promise<boolean>
Implementation of AtomicTakeStorage.putIfAbsent
- Defined in src/lib/storage/MemoryStorage.ts:88

replaceIfVersion

replaceIfVersion(
    key: string,
    expectedVersion: string,
    value: T,
    ttl?: number,
): Promise<boolean>
Parameters
- key: string
- expectedVersion: string
- value: T
- Optionalttl: number
Returns Promise<boolean>
- Defined in src/lib/storage/MemoryStorage.ts:103

takeIfVersion

takeIfVersion(key: string, expectedVersion: string): Promise<T | undefined>
Parameters
- key: string
- expectedVersion: string
Returns Promise<T | undefined>
- Defined in src/lib/storage/MemoryStorage.ts:126

putForSettlementOperationIfAbsent

putForSettlementOperationIfAbsent(
    operationId: string,
    key: string,
    value: T,
    ttl?: number,
): Promise<boolean>
Parameters
- operationId: string
- key: string
- value: T
- Optionalttl: number
Returns Promise<boolean>
- Defined in src/lib/storage/MemoryStorage.ts:143

getBySettlementOperationId

getBySettlementOperationId(
operationId: string,
): Promise<{ token: string; state: T } | undefined>
Parameters
- operationId: string
Returns Promise<{ token: string; state: T } | undefined>
- Defined in src/lib/storage/MemoryStorage.ts:162

replaceForSettlementOperationIfVersion

replaceForSettlementOperationIfVersion(
    operationId: string,
    currentKey: string,
    expectedVersion: string,
    replacementKey: string,
    replacementValue: T,
    ttl?: number,
): Promise<boolean>
Parameters
- operationId: string
- currentKey: string
- expectedVersion: string
- replacementKey: string
- replacementValue: T
- Optionalttl: number
Returns Promise<boolean>
- Defined in src/lib/storage/MemoryStorage.ts:173

set

set(key: string, value: T, ttl?: number): Promise<void>
Set a value with optional TTL
Parameters
- key: string
  Storage key
- value: T
  Value to store
- Optionalttl: number
  Time to live in seconds (optional)
Returns Promise<void>
Implementation of PatternStorage.set
- Defined in src/lib/storage/MemoryStorage.ts:206

delete

delete(key: string): Promise<void>
Delete a value by key
Parameters
- key: string
  Storage key
Returns Promise<void>
Implementation of PatternStorage.delete
- Defined in src/lib/storage/MemoryStorage.ts:226

has

has(key: string): Promise<boolean>
Check if a key exists
Parameters
- key: string
  Storage key
Returns Promise<boolean>
Implementation of PatternStorage.has
- Defined in src/lib/storage/MemoryStorage.ts:231

clear

clear(): Promise<void>
Clear all stored values (optional)

Returns Promise<void>
Implementation of PatternStorage.clear
- Defined in src/lib/storage/MemoryStorage.ts:236

keys

keys(): Promise<string[]>
Get all keys (optional, for debugging)

Returns Promise<string[]>
Implementation of PatternStorage.keys
- Defined in src/lib/storage/MemoryStorage.ts:241

size

size(): Promise<number>
Get storage size/count (optional, for monitoring)

Returns Promise<number>
Implementation of PatternStorage.size
- Defined in src/lib/storage/MemoryStorage.ts:255

mget

mget(keys: string[]): Promise<(T | undefined)[]>
Get multiple values at once
Parameters
- keys: string[]
Returns Promise<(T | undefined)[]>
Implementation of BatchStorage.mget
- Defined in src/lib/storage/MemoryStorage.ts:263

mset

mset(entries: { key: string; value: T; ttl?: number }[]): Promise<void>
Set multiple values at once
Parameters
- entries: { key: string; value: T; ttl?: number }[]
Returns Promise<void>
Implementation of BatchStorage.mset
- Defined in src/lib/storage/MemoryStorage.ts:268

mdel

mdel(keys: string[]): Promise<number>
Delete multiple keys at once
Parameters
- keys: string[]
Returns Promise<number>
Implementation of BatchStorage.mdel
- Defined in src/lib/storage/MemoryStorage.ts:273

scan

scan(pattern: string): Promise<string[]>
Get keys matching a pattern
Parameters
- pattern: string
Returns Promise<string[]>
Implementation of PatternStorage.scan
- Defined in src/lib/storage/MemoryStorage.ts:287

deletePattern

deletePattern(pattern: string): Promise<number>
Delete keys matching a pattern
Parameters
- pattern: string
Returns Promise<number>
Implementation of PatternStorage.deletePattern
- Defined in src/lib/storage/MemoryStorage.ts:293

cleanupExpired

cleanupExpired(): number
Manually trigger cleanup of expired items

Returns number
- Defined in src/lib/storage/MemoryStorage.ts:303

getStats

getStats(): {
    totalItems: number;
    expiredItems: number;
    memoryUsage: number;
    lastCleanup: number;
    oldestItem?: number;
    newestItem?: number;
}
Get storage statistics

Returns {
    totalItems: number;
    expiredItems: number;
    memoryUsage: number;
    lastCleanup: number;
    oldestItem?: number;
    newestItem?: number;
}
- Defined in src/lib/storage/MemoryStorage.ts:322

destroy

destroy(): void
Destroy the storage and cleanup resources

Returns void
- Defined in src/lib/storage/MemoryStorage.ts:393

Class MemoryStorage<T>

Example

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

OptionalcleanupIntervalMs?: number

OptionalmaxItems?: number

OptionalautoCleanup?: boolean

Returns MemoryStorage<T>

Methods

get

Parameters

Returns Promise<T | undefined>

take

Parameters

Returns Promise<T | undefined>

putIfAbsent

Parameters

Returns Promise<boolean>

replaceIfVersion

Parameters

Returns Promise<boolean>

takeIfVersion

Parameters

Returns Promise<T | undefined>

putForSettlementOperationIfAbsent

Parameters

Returns Promise<boolean>

getBySettlementOperationId

Parameters

Returns Promise<{ token: string; state: T } | undefined>

replaceForSettlementOperationIfVersion

Parameters

Returns Promise<boolean>

set

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

has

Parameters

Returns Promise<boolean>

clear

Returns Promise<void>

keys

Returns Promise<string[]>

size

Returns Promise<number>

mget

Parameters

Returns Promise<(T | undefined)[]>

mset

Parameters

Returns Promise<void>

mdel

Parameters

Returns Promise<number>

scan

Parameters

Returns Promise<string[]>

deletePattern

Parameters

Returns Promise<number>

cleanupExpired

Returns number

getStats

Returns { totalItems: number; expiredItems: number; memoryUsage: number; lastCleanup: number; oldestItem?: number; newestItem?: number;}

destroy

Returns void

Settings

On This Page

`Optional`cleanupIntervalMs?: number

`Optional`maxItems?: number

`Optional`autoCleanup?: boolean

Returns {
totalItems: number;
expiredItems: number;
memoryUsage: number;
lastCleanup: number;
oldestItem?: number;
newestItem?: number;
}