Interface Storage<T>

Generic storage interface for caching and persistence

Users can provide their own implementations (Redis, database, etc.) The library provides a default in-memory implementation

interface Storage<T> {
    get(key: string): Promise<undefined | T>;
    set(key: string, value: T, ttl?: number): Promise<void>;
    delete(key: string): Promise<void>;
    has(key: string): Promise<boolean>;
    clear?(): Promise<void>;
    keys?(): Promise<string[]>;
    size?(): Promise<number>;
}

Type Parameters

T

Hierarchy (View Summary)

Storage
- BatchStorage
- PatternStorage

Implemented by

MemoryStorage

Index

Methods

get set delete has clear? keys? size?

Methods

get

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

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>
- Defined in src/lib/storage/interfaces.ts:24

delete

delete(key: string): Promise<void>
Delete a value by key
Parameters
- key: string
  Storage key
Returns Promise<void>
- Defined in src/lib/storage/interfaces.ts:30

has

has(key: string): Promise<boolean>
Check if a key exists
Parameters
- key: string
  Storage key
Returns Promise<boolean>
- Defined in src/lib/storage/interfaces.ts:36

`Optional`clear

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

Returns Promise<void>
- Defined in src/lib/storage/interfaces.ts:41

`Optional`keys

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

Returns Promise<string[]>
- Defined in src/lib/storage/interfaces.ts:46

`Optional`size

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

Returns Promise<number>
- Defined in src/lib/storage/interfaces.ts:51