Dismissible manages the state of your UI elements across sessions, so your users see what matters, once! No more onboarding messages reappearing on every tab, no more notifications haunting users across devices. Dismissible syncs dismissal state everywhere, so every message is intentional, never repetitive.

@dismissible/nestjs-redis-cache

Redis cache adapter for the Dismissible system.

Overview

This library provides:

• RedisCacheAdapter - Redis-backed cache implementation using ioredis
• Distributed caching for the Dismissible system
• Suitable for multi-instance deployments

Installation

npm install @dismissible/nestjs-redis-cache

Getting Started

Using Redis Cache

The Redis cache adapter is useful for production deployments with multiple instances:

import { Module } from '@nestjs/common';
import { DismissibleModule } from '@dismissible/nestjs-core';
import { RedisCacheModule } from '@dismissible/nestjs-redis-cache';

@Module({
  imports: [
    DismissibleModule.forRoot({
      cache: RedisCacheModule.forRoot({
        url: 'redis://localhost:6379',
        keyPrefix: 'dismissible:cache:',
        ttlMs: 6 * 60 * 60 * 1000, // 6 hours
      }),
    }),
  ],
})
export class AppModule {}

Configuration Options

• url (required): Redis connection URL (e.g., redis://localhost:6379 or redis://:password@host:port)
• keyPrefix (optional): Key prefix for cache keys (default: 'dismissible:cache:')
• ttlMs (optional): Time-to-live in milliseconds (default: 6 hours)
• enableReadyCheck (optional): Enable ready check (default: true)
• maxRetriesPerRequest (optional): Maximum retries per request (default: 3)
• connectionTimeoutMs (optional): Connection timeout in milliseconds

API Reference

RedisCacheAdapter

A Redis implementation of IDismissibleCache using ioredis. Data is stored in Redis and persists across application restarts.

Note: This adapter is suitable for distributed systems and production deployments. For single-instance deployments, consider using @dismissible/nestjs-memory-cache.

RedisCacheModule

RedisCacheModule.forRoot(options)

Register the Redis cache adapter with configuration options.

RedisCacheModule.forRootAsync(options)

Register the Redis cache adapter with async configuration.

License

MIT