@knaus94/nestjs-redis-cacheable v1.0.6

nestjs-redis-cacheable

Service-level caching for NestJS with pluggable serializers.

@knaus94/nestjs-redis-cacheable extends the standard CacheModule so you can cache service method calls—not only controller responses—using two simple decorators:

Installation

npm i @knaus94/nestjs-redis-cacheable          # or
yarn add @knaus94/nestjs-redis-cacheable

Quick Start

// app.module.ts
import { Module, CacheModule } from '@nestjs/common';
import { CacheableModule } from '@knaus94/nestjs-redis-cacheable';

@Module({
  imports: [
    CacheModule.register({ isGlobal: true }), // any cache-manager store
    CacheableModule.register(),               // default JSON serializer
  ],
})
export class AppModule {}

// user.service.ts
@Injectable()
export class UserService {
  /** Result is cached for 5 seconds */
  @Cacheable({
    key: (id: number) => `username-${id}`,
    namespace: 'user',
    ttl: 5000,              // milliseconds
  })
  async getUserName(id: number) {
    return this.db.query(/* … */);
  }

  /** Cache entry is removed after deletion */
  @CacheEvict({
    key: (id: number) => `username-${id}`,
    namespace: 'user',
  })
  async deleteUser(id: number) {
    await this.db.delete(/* … */);
  }
}

Switching to MsgPack

Any storage format can be plugged in via the Serializer interface. Below is a ready-to-use MsgPack serializer (binary, no Base64) with custom support for Decimal and Date.

// msgpack.serializer.ts
import { encode, decode, createCodec } from 'msgpack-lite';
import { Decimal } from '@prisma/client/runtime/library';
import { Serializer } from '@knaus94/nestjs-redis-cacheable';

const codec = createCodec();
codec.addExtPacker(0x3f, Decimal, d => encode(d.toString()));
codec.addExtUnpacker(0x3f, b => new Decimal(decode(b)));
codec.addExtPacker(0x0d, Date,    d => encode(d.toISOString()));
codec.addExtUnpacker(0x0d, b => new Date(decode(b)));

export const msgPackSerializer: Serializer<Buffer> = {
  storage: 'buffer',                       // tells the module to use Buffer I/O
  serialize: data => encode(data, { codec }),
  deserialize: buf => decode(buf, { codec }),
};

Register it:

// app.module.ts
import { Module, CacheModule } from '@nestjs/common';
import { CacheableModule } from '@knaus94/nestjs-redis-cacheable';
import { msgPackSerializer } from './msgpack.serializer';

@Module({
  imports: [
    CacheModule.register({ isGlobal: true }),
    CacheableModule.register({
      defaultTTL: 60_000,       // optional global TTL
      serializer: msgPackSerializer,
    }),
  ],
})
export class AppModule {}

Now every cached value is stored in Redis as raw MsgPack bytes; switch back to JSON at any time by omitting the serializer option.

License

MIT licensed.