@lemur-bookstores/secure-stack-cache

@lemur-bookstores/secure-stack-cache

A robust caching module for SecureStack with support for multiple providers (Memory, Redis, Memcached).

Features

• 🔌 Driver-based architecture: Easily switch between caching strategies.
• 💾 Memory Provider: Built-in LRU cache for development and testing.
• 🚀 Redis Provider: High-performance caching using ioredis.
• 📦 Memcached Provider: Alternative caching using memjs.
• 🗄️ SQLite Provider: Persistent local caching using better-sqlite3.
• 🍃 MongoDB Provider: Distributed document caching using mongodb.
• 🛡️ Unified API: Consistent interface across all providers.
• ⏱️ TTL Support: Time-to-live support for all operations.

Installation

npm install @lemur-bookstores/secure-stack-cache

Usage

Basic Usage (Memory)

import { CacheManager } from '@lemur-bookstores/secure-stack-cache';

const cache = new CacheManager({
  store: 'memory',
  memory: {
    max: 500, // Max items
    ttl: 60,  // Default TTL in seconds
  },
});

await cache.set('key', 'value');
const value = await cache.get('key');

Redis Usage

import { CacheManager } from '@lemur-bookstores/secure-stack-cache';

const cache = new CacheManager({
  store: 'redis',
  redis: {
    host: 'localhost',
    port: 6379,
    ttl: 3600, // Default TTL
  },
});

Memcached Usage

import { CacheManager } from '@lemur-bookstores/secure-stack-cache';

const cache = new CacheManager({
  store: 'memcached',
  memcached: {
    servers: 'localhost:11211',
    options: {
      expires: 60,
    },
  },
});

SQLite Usage

import { CacheManager } from '@lemur-bookstores/secure-stack-cache';

const cache = new CacheManager({
  store: 'sqlite',
  sqlite: {
    path: './cache.sqlite', // Defaults to :memory:
    table: 'my_cache',      // Defaults to 'cache'
    ttl: 60,
  },
});

MongoDB Usage

import { CacheManager } from '@lemur-bookstores/secure-stack-cache';

const cache = new CacheManager({
  store: 'mongo',
  mongo: {
    url: 'mongodb://localhost:27017',
    dbName: 'my_app',
    collectionName: 'cache_items',
    ttl: 60,
  },
});

API

CacheManager

• get<T>(key: string): Promise<T | null>
• set<T>(key: string, value: T, ttl?: number): Promise<void>
• del(key: string): Promise<void>
• clear(): Promise<void>
• has(key: string): Promise<boolean>
• getProvider(): CacheProvider

License

MIT