CacheModule

Module that provides Nest cache-manager.

  
class CacheModule extends ConfigurableModuleClass {
  static register<StoreConfig extends Record<any, any> = Record<string, any>>(options: CacheModuleOptions<StoreConfig> = {} as any): DynamicModule
  static registerAsync<StoreConfig extends Record<any, any> = Record<string, any>>(options: CacheModuleAsyncOptions<StoreConfig>): DynamicModule
}

See also

Static methods

register()

Configure the cache manager statically.


static register<StoreConfig extends Record<any, any> = Record<string, any>>(options: CacheModuleOptions<StoreConfig> = {} as any): DynamicModule

Parameters

Option Type Description
options CacheModuleOptions

options to configure the cache manager


Optional. Default is `{} as any`.

Returns

DynamicModule

registerAsync()

Configure the cache manager dynamically.


static registerAsync<StoreConfig extends Record<any, any> = Record<string, any>>(options: CacheModuleAsyncOptions<StoreConfig>): DynamicModule

Parameters

Option Type Description
options CacheModuleAsyncOptions

method for dynamically supplying cache manager configuration options

Returns

DynamicModule