Api References NestJS

CacheManagerOptions

interface

Interface defining Cache Manager configuration options.


interface CacheManagerOptions extends Omit {
  stores?: Keyv | KeyvStoreAdapter | (Keyv | KeyvStoreAdapter)[]
  namespace?: string
  ttl?: number
  refreshThreshold?: number
  nonBlocking?: boolean
}

Properties

Property	Description
`stores?: Keyv \| KeyvStoreAdapter \| (Keyv \| KeyvStoreAdapter)[]`	Cache storage manager. Default is `'memory'` (in-memory store). See Different stores for more info.
`namespace?: string`	Cache storage namespace, default is `keyv`. This is a global configuration that applies to all `KeyvStoreAdapter` instances.
`ttl?: number`	Default time to live in milliseconds. This is the maximum duration an item can remain in the cache before being removed.
`refreshThreshold?: number`	Optional. If refreshThreshold is set, the TTL will be checked after retrieving a value from the cache. If the remaining TTL is less than the refreshThreshold, the system will update the value asynchronously.
`nonBlocking?: boolean`	Default is false. If set to true, the system will not block when using multiple stores. For more information on how this affects function types, visit documentation.