najm-cache

Unified cache plugin for Najm with Memory and Redis drivers. Auto-falls back to in-memory when Redis is unavailable.

Install

bun add najm-cache

Peer dependency: reflect-metadata (optional). Optional peer: ioredis.

Usage

Memory Cache (default, no setup)

import { Server } from 'najm-core';
import { cache } from 'najm-cache';

await new Server()
  .use(cache())
  .listen(3000);

Redis Cache

await new Server()
  .use(cache({ redis: { url: process.env.REDIS_URL! } }))
  .listen(3000);

Redis is optional — if not available, falls back to in-memory automatically.

In Services

import { Service, Injectable } from 'najm-core';
import { CacheService } from 'najm-cache';

@Injectable()
class MyService {
  constructor(private cache: CacheService) {}

  async getUser(id: string) {
    return this.cache.getOrSet(`user:${id}`, () => fetchUser(id), 300000);
  }

  async invalidateUser(id: string) {
    await this.cache.delete(`user:${id}`);
  }
}

CacheService API

| Method | Description | |--------|-------------| | get(key) | Get a value | | set(key, value, ttlMs?) | Set a value with optional TTL | | delete(key) | Delete a key | | getJson<T>(key) | Get and parse JSON | | setJson(key, value, ttlMs?) | Set JSON value | | getOrSet(key, factory, ttlMs?) | Cache-aside pattern | | incr(key, ttlMs?) | Atomic increment (for rate limiting) |

Production Notes

• Use Redis for multi-instance deployments; memory driver is single-instance only
• Token blacklist in najm-auth uses the cache plugin — configure Redis for distributed session revocation
• reflect-metadata optional peer dependency; only needed if using DI decorators