Class: CacheService
Implements
ICacheServiceCopy to Clipboard
Constructors
constructor
• new CacheService(__namedParametersCopy to Clipboard)
Parameters
| Name | Type |
|---|---|
__namedParametersCopy to Clipboard | ObjectCopy to Clipboard |
Defined in
packages/medusa/src/services/cache.ts:10
Properties
redis_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard redis_: RedisCopy to Clipboard
Defined in
packages/medusa/src/services/cache.ts:8
Methods
get
▸ get<TCopy to Clipboard>(cacheKeyCopy to Clipboard): PromiseCopy to Clipboard<nullCopy to Clipboard | TCopy to Clipboard>
Retrieve a cached value belonging to the given key.
Type parameters
| Name |
|---|
TCopy to Clipboard |
Parameters
| Name | Type |
|---|---|
cacheKeyCopy to Clipboard | stringCopy to Clipboard |
Returns
PromiseCopy to Clipboard<nullCopy to Clipboard | TCopy to Clipboard>
Implementation of
ICacheService.get
Defined in
packages/medusa/src/services/cache.ts:40
invalidate
▸ invalidate(keyCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Invalidate cache for a specific key. a key can be either a specific key or more global such as "ps:*".
Parameters
| Name | Type |
|---|---|
keyCopy to Clipboard | stringCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Implementation of
ICacheService.invalidate
Defined in
packages/medusa/src/services/cache.ts:56
set
▸ set(keyCopy to Clipboard, dataCopy to Clipboard, ttl?Copy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Set a key/value pair to the cache. It is also possible to manage the ttl through environment variable using CACHE_TTL. If the ttl is 0 it will act like the value should not be cached at all.
Parameters
| Name | Type | Default value |
|---|---|---|
keyCopy to Clipboard | stringCopy to Clipboard | undefinedCopy to Clipboard |
dataCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | undefinedCopy to Clipboard |
ttlCopy to Clipboard | numberCopy to Clipboard | DEFAULT_CACHE_TIMECopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Implementation of
ICacheService.set