Class KvStore`Abstract`

Abstract base class for key-value store adapters.

Provides static validation helpers. Subclasses implement the public methods directly and call the validators as needed.

Hierarchy (View Summary)

KvStore
- BunRedisStore
- MemoryStore

Index

Constructors

Methods

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

Constructors

constructor

new KvStore(): KvStore
Returns KvStore

Methods

`Abstract`clean

clean(): number | Promise<number>
Returns number | Promise<number>
- Defined in kv-store.ts:73

`Optional`close

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

`Optional`connect

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

`Abstract`decrement

decrement(key: string, amount?: number): number | Promise<number>
Parameters
- key: string
- Optionalamount: number
Returns number | Promise<number>
- Defined in kv-store.ts:69

`Abstract`del

del(key: string): boolean | Promise<boolean>
Parameters
- key: string
Returns boolean | Promise<boolean>
- Defined in kv-store.ts:70

`Abstract`expire

expire(key: string, ttlSec: number): boolean | Promise<boolean>
Parameters
- key: string
- ttlSec: number
Returns boolean | Promise<boolean>
- Defined in kv-store.ts:71

`Abstract`get

get<T = unknown>(key: string): T | Promise<T | null> | null
Type Parameters
- T = unknown
Parameters
- key: string
Returns T | Promise<T | null> | null
- Defined in kv-store.ts:66

`Abstract`increment

increment(key: string, amount?: number): number | Promise<number>
Parameters
- key: string
- Optionalamount: number
Returns number | Promise<number>
- Defined in kv-store.ts:68

`Abstract`set

set<T = unknown>(key: string, value: T, ttlSec?: number): void | Promise<void>
Type Parameters
- T = unknown
Parameters
- key: string
- value: T
- OptionalttlSec: number
Returns void | Promise<void>
- Defined in kv-store.ts:67

`Abstract`ttl

ttl(key: string): number | Promise<number>
Parameters
- key: string
Returns number | Promise<number>
- Defined in kv-store.ts:72

`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.
- 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.
- 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.
- Defined in kv-store.ts:41