KV Store is a flexible key-value store interface library that provides a unified KvStore API allowing custom storage implementations. It includes built-in adapters for Redis (via IoRedis) and in-memory storage by default.
This library is perfect for applications that need to abstract their storage layer, allowing easy switching between different storage backends without changing your application code.
bun add @nowarajs/kv-store @nowarajs/error
For Redis support, you'll also need to install IoRedis:
bun add ioredis
import { MemoryStore } from '@nowarajs/kv-store'
// Create a memory store with default cleanup interval (5 minutes)
const store = new MemoryStore()
// Or with custom cleanup interval (in milliseconds)
const storeWithCustomCleanup = new MemoryStore(60000) // 1 minute
// Basic operations
store.set('user:123', { name: 'John', age: 30 })
const user = store.get<{ name: string; age: number }>('user:123')
// With TTL (time-to-live in seconds)
store.set('session:abc', 'session-data', 3600) // Expires in 1 hour
// Atomic operations
store.set('counter', 0)
store.increment('counter', 5) // Returns 5
store.decrement('counter', 2) // Returns 3
// Key management
store.expire('user:123', 300) // Set expiration to 5 minutes
store.del('user:123') // Delete key
import { IoRedisStore } from '@nowarajs/kv-store'
// Create Redis store
const store = new IoRedisStore({
host: 'localhost',
port: 6379,
// ... other IoRedis options
})
// Connect to Redis
await store.connect()
// Same API as memory store, but async
await store.set('user:123', { name: 'John', age: 30 })
const user = await store.get<{ name: string; age: number }>('user:123')
// With TTL
await store.set('session:abc', 'session-data', 3600)
// Atomic operations
await store.increment('counter', 5)
await store.decrement('counter', 2)
// Close connection when done
await store.close()
import type { KvStore } from '@nowarajs/kv-store'
class MyCustomStore implements KvStore {
public async connect?(): Promise<void> {
// Custom connection logic
}
public async close?(): Promise<void> {
// Custom cleanup logic
}
public get<T = unknown>(key: string): T | null | Promise<T | null> {
// Custom get implementation
}
public set<T = unknown>(key: string, value: T, ttlSec?: number): void | Promise<void> {
// Custom set implementation
}
public increment(key: string, amount = 1): number | Promise<number> {
// Custom increment implementation
}
public decrement(key: string, amount = 1): number | Promise<number> {
// Custom decrement implementation
}
public del(key: string): boolean | Promise<boolean> {
// Custom delete implementation
}
public expire(key: string, ttlSec: number): boolean | Promise<boolean> {
// Custom expiration implementation
}
public exists(key: string): boolean | Promise<boolean> {
// Custom exists check implementation
}
public clear(): void | Promise<void> {
// Custom clear all implementation
}
}
You can find the complete API reference documentation for kv-store at:
Distributed under the MIT License. See LICENSE for more information.