Class MemoryStore

In-memory key-value store adapter with automatic cleanup of expired entries.

Provides a memory-based implementation of KvStore with TTL support and automatic background cleanup of expired entries.

Hierarchy (View Summary)

KvStore
- MemoryStore

Index

Constructors

Methods

clean close? connect? decrement del destroy expire get increment set ttl _validateAmount _validateKey _validateTtl

Constructors

constructor

new MemoryStore(cleanupIntervalMs?: number, maxSize?: number): MemoryStore
Parameters
- OptionalcleanupIntervalMs: number
- OptionalmaxSize: number
Returns MemoryStore
Overrides KvStore.constructor
- Defined in memory-store.ts:52

Methods

clean

clean(): number
Returns number
Overrides KvStore.clean
- Defined in memory-store.ts:125

`Optional`close

close?(): void | Promise<void>
Returns void | Promise<void>
Inherited from KvStore.close
- Defined in kv-store.ts:17

`Optional`connect

connect?(): void | Promise<void>
Returns void | Promise<void>
Inherited from KvStore.connect
- Defined in kv-store.ts:16

decrement

decrement(key: string, amount?: number): number
Parameters
- key: string
- amount: number = 1
Returns number
Overrides KvStore.decrement
- Defined in memory-store.ts:91

del

del(key: string): boolean
Parameters
- key: string
Returns boolean
Overrides KvStore.del
- Defined in memory-store.ts:97

destroy

destroy(): void
Returns void
- Defined in memory-store.ts:149

expire

expire(key: string, ttlSec: number): boolean
Parameters
- key: string
- ttlSec: number
Returns boolean
Overrides KvStore.expire
- Defined in memory-store.ts:102

get

get<T = unknown>(key: string): T | null
Type Parameters
- T = unknown
Parameters
- key: string
Returns T | null
Overrides KvStore.get
- Defined in memory-store.ts:59

increment

increment(key: string, amount?: number): number
Parameters
- key: string
- amount: number = 1
Returns number
Overrides KvStore.increment
- Defined in memory-store.ts:85

set

set<T = unknown>(key: string, value: T, ttlSec?: number): void
Type Parameters
- T = unknown
Parameters
- key: string
- value: T
- OptionalttlSec: number
Returns void
Overrides KvStore.set
- Defined in memory-store.ts:74

ttl

ttl(key: string): number
Parameters
- key: string
Returns number
Overrides KvStore.ttl
- Defined in memory-store.ts:113

`Protected` `Static`_validateAmount

_validateAmount(amount: number): void
Validates an increment/decrement amount and throws an exception if it's invalid.
Parameters
- amount: number
  The amount to validate.
Returns void
Throws
(Exception) - If the amount is invalid.
Inherited from KvStore._validateAmount
- Defined in kv-store.ts:58

`Protected` `Static`_validateKey

_validateKey(key: string): void
Validates a key string and throws an exception if it's invalid.
Parameters
- key: string
  The key to validate.
Returns void
Throws
(Exception) - If the key is invalid.
Inherited from KvStore._validateKey
- Defined in kv-store.ts:26

`Protected` `Static`_validateTtl

_validateTtl(ttlSec: number | undefined): void
Validates a TTL value and throws an exception if it's invalid.
Parameters
- ttlSec: number | undefined
  The TTL value to validate.
Returns void
Throws
(Exception) - If the TTL is invalid.
Inherited from KvStore._validateTtl
- Defined in kv-store.ts:41