Class CacheManager

Index

Constructors

Properties

Methods

clean clear delete get has put

Constructors

constructor

new CacheManager(
options?: CacheManagerOptions,
deps?: CacheManagerDeps,
): CacheManager
Parameters
- Optionaloptions: CacheManagerOptions
- Optionaldeps: CacheManagerDeps
Returns CacheManager
- Defined in CacheManager.ts:126

Properties

`Readonly`name

name: string

`Optional`onError

onError?: (error: Error) => void

If set, when asynchronous caching has failed, this callback will be invoked. This is not invoked when a promise rejects during an operation.

Methods

clean

clean(options?: CacheCleanOptions): Promise<void>
Cleans stale items from the cache.
Parameters
- Optionaloptions: CacheCleanOptions
Returns Promise<void>
- Defined in CacheManager.ts:278

clear

clear(): Promise<boolean>
Returns Promise<boolean>
a promise that resolves to true if the Cache object is found and deleted, and false otherwise.
- Defined in CacheManager.ts:269

delete

delete(cacheId: RequestInfo): Promise<boolean>
Deletes the request from this cache.
Parameters
- cacheId: RequestInfo
  The request or cache id used as the cache key.
Returns Promise<boolean>
- Defined in CacheManager.ts:167

get

get(request: RequestInfo, options?: CacheEntryOptions): Promise<Response>
Parameters
- request: RequestInfo
- Optionaloptions: CacheEntryOptions
Returns Promise<Response>
- Defined in CacheManager.ts:181

has

has(cacheId: RequestInfo): Promise<boolean>
Resolves to true if the request is cached.
Parameters
- cacheId: RequestInfo
Returns Promise<boolean>
- Defined in CacheManager.ts:177

put

put(cacheId: RequestInfo, response: Response): Promise<Response>
Caches a response with added expiry headers.
Parameters
- cacheId: RequestInfo
- response: Response
Returns Promise<Response>
- Defined in CacheManager.ts:141