Api References NestJS

CacheModuleAsyncOptions

interface

Options for dynamically configuring the Cache module.


interface CacheModuleAsyncOptions<StoreConfig extends Record<any, any> = Record<string, any>> extends ConfigurableModuleAsyncOptions, keyof CacheOptionsFactory> {
  useExisting?: Type<CacheOptionsFactory<StoreConfig>>
  useClass?: Type<CacheOptionsFactory<StoreConfig>>
  useFactory?: (...args: any[]) => Promise<CacheModuleOptions<StoreConfig>> | CacheModuleOptions<StoreConfig>
  inject?: any[]
  extraProviders?: Provider[]
  isGlobal?: boolean
}

Properties

Property	Description
`useExisting?: Type<CacheOptionsFactory<StoreConfig>>`	Injection token resolving to an existing provider. The provider must implement the `CacheOptionsFactory` interface.
`useClass?: Type<CacheOptionsFactory<StoreConfig>>`	Injection token resolving to a class that will be instantiated as a provider. The class must implement the `CacheOptionsFactory` interface.
`useFactory?: (...args: any[]) => Promise<CacheModuleOptions<StoreConfig>> \| CacheModuleOptions<StoreConfig>`	Function returning options (or a Promise resolving to options) to configure the cache module.
`inject?: any[]`	Dependencies that a Factory may inject.
`extraProviders?: Provider[]`	Extra providers to be registered within a scope of this module.
`isGlobal?: boolean`	If "true', register `CacheModule` as a global module.

See also#

Properties

See also