Class: CacheModule

Defined in: packages/cache/src/cache.module.ts:77

Module that provides caching functionality for nestelia.

This module wraps the cache-manager library and provides:

• In-memory caching by default
• Support for Redis and other stores
• Configurable TTL and refresh thresholds
• CacheInterceptor for automatic HTTP caching

Examples

@Module({
  imports: [CacheModule.register({ ttl: 60000 })],
})
export class AppModule {}

With async configuration:

@Module({
  imports: [
    CacheModule.registerAsync({
      useFactory: (config: ConfigService) => ({
        store: redisStore,
        ttl: config.get('CACHE_TTL'),
      }),
      inject: [ConfigService],
    }),
  ],
})
export class AppModule {}

Extends

• ConfigurableModuleClass

Indexable

[key: string]: any

Constructors

Constructor

new CacheModule(): CacheModule;

Defined in: packages/core/src/module-utils/interfaces/configurable-module-cls.interface.ts:22

Returns

CacheModule

Inherited from

ConfigurableModuleClass.constructor

Methods

forRoot()

static forRoot<T>(options?): DynamicModule;

Defined in: packages/cache/src/cache.module.ts:90

Type Parameters

Type Parameter	Default type
T extends Record<string, unknown>	Record<string, unknown>

Parameters

Parameter	Type
options	CacheModuleOptions<T>

Returns

DynamicModule

---

forRootAsync()

static forRootAsync<T>(options): DynamicModule;

Defined in: packages/cache/src/cache.module.ts:96

Type Parameters

Type Parameter	Default type
T extends Record<string, unknown>	Record<string, unknown>

Parameters

Parameter	Type
options	CacheModuleAsyncOptions<T>

Returns

DynamicModule

---

register()

static register<T>(options?): DynamicModule;

Defined in: packages/cache/src/cache.module.ts:78

Type Parameters

Type Parameter	Default type
T extends Record<string, unknown>	Record<string, unknown>

Parameters

Parameter	Type
options	CacheModuleOptions<T>

Returns

DynamicModule

Overrides

ConfigurableModuleClass.register

---

registerAsync()

static registerAsync<T>(options): DynamicModule;

Defined in: packages/cache/src/cache.module.ts:84

Type Parameters

Type Parameter	Default type
T extends Record<string, unknown>	Record<string, unknown>

Parameters

Parameter	Type
options	CacheModuleAsyncOptions<T>

Returns

DynamicModule

Overrides

ConfigurableModuleClass.registerAsync