Class MemoryCache

Implements an in-memory cache.

Implements

Cache

Index

Constructors

Methods

clear delete get has set

Constructors

constructor

new MemoryCache(options?: Partial): MemoryCache
Creates a new memory service.
Parameters
- options: Partial = {}
  An object providing values to initialize this instance.
Returns MemoryCache
- Defined in src/Caching/MemoryCache.ts:33

Methods

clear

clear(): Promise<void>
Removes all entries from this cache.

Returns Promise<void>
Resolves when this cache has been cleared.
Implementation of Cache.clear
- Defined in src/Caching/MemoryCache.ts:43

delete

delete(key: string): Promise<void>
Removes the value associated with the specified key.
Parameters
- key: string
  The cache key.
Returns Promise<void>
Resolves when the value has been removed.
Implementation of Cache.delete
- Defined in src/Caching/MemoryCache.ts:53

get

get<T>(key: string): Promise<null | T>
Gets the value associated with the specified key.
Type Parameters
- T
Parameters
- key: string
  The cache key.
Returns Promise<null | T>
The cached value, or null if the key does not exist.
Implementation of Cache.get
- Defined in src/Caching/MemoryCache.ts:63

has

has(key: string): Promise<boolean>
Gets a value indicating whether this cache contains the specified key.
Parameters
- key: string
  The cache key.
Returns Promise<boolean>
true if this cache contains the specified key, otherwise false.
Implementation of Cache.has
- Defined in src/Caching/MemoryCache.ts:72

set

set(key: string, value: unknown, duration?: number): Promise<MemoryCache>
Associates a given value with the specified key.
Parameters
- key: string
  The cache key.
- value: unknown
  The value to be cached.
- duration: number = -1
  The number of seconds in which the cached value will expire.
Returns Promise<MemoryCache>
This instance.
Implementation of Cache.set
- Defined in src/Caching/MemoryCache.ts:83