Class: Cache

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

Empty base class that will be merged with the Cache interface.

This class can be used as a provider token for dependency injection.

Extends

• ReturnType<typeof createCache>

Constructors

Constructor

new Cache(): Cache;

Returns

Cache

Methods

wrap()

Call Signature

wrap<T>(
   key, 
   fnc, 
   ttl?, 
   refreshThreshold?
): Promise<T>;

Defined in: node_modules/cache-manager/dist/index.d.mts:74

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string
fnc	() => T | Promise<T>
ttl?	number | ((value) => number)
refreshThreshold?	number | ((value) => number)

Returns

Promise<T>

Call Signature

wrap<T>(
   key, 
   fnc, 
   options
): Promise<T>;

Defined in: node_modules/cache-manager/dist/index.d.mts:75

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string
fnc	() => T | Promise<T>
options	WrapOptions<T>

Returns

Promise<T>

Call Signature

wrap<T>(
   key, 
   fnc, 
   options
): Promise<StoredDataRaw<T>>;

Defined in: node_modules/cache-manager/dist/index.d.mts:76

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string
fnc	() => T | Promise<T>
options	WrapOptionsRaw<T>

Returns

Promise<StoredDataRaw<T>>

Properties

Property	Type	Defined in
cacheId	() => string	node_modules/cache-manager/dist/index.d.mts:72
clear	() => Promise<boolean>	node_modules/cache-manager/dist/index.d.mts:68
del	(key) => Promise<boolean>	node_modules/cache-manager/dist/index.d.mts:66
disconnect	() => Promise<undefined>	node_modules/cache-manager/dist/index.d.mts:71
get	<T>(key) => Promise<T | undefined>	node_modules/cache-manager/dist/index.d.mts:53
mdel	(keys) => Promise<boolean>	node_modules/cache-manager/dist/index.d.mts:67
mget	<T>(keys) => Promise<(T | undefined)[]>	node_modules/cache-manager/dist/index.d.mts:54
mset	<T>(list) => Promise<{ key: string; ttl?: number; value: T; }[]>	node_modules/cache-manager/dist/index.d.mts:57
off	<E>(event, listener) => EventEmitter	node_modules/cache-manager/dist/index.d.mts:70
on	<E>(event, listener) => EventEmitter	node_modules/cache-manager/dist/index.d.mts:69
set	<T>(key, value, ttl?) => Promise<T>	node_modules/cache-manager/dist/index.d.mts:56
stores	Keyv<any>[]	node_modules/cache-manager/dist/index.d.mts:73
ttl	(key) => Promise<number | undefined>	node_modules/cache-manager/dist/index.d.mts:55