Class CacheStoreCache

Implements

ICache

Index

Constructors

constructor

Methods

get getETag set has delete deleteByPath clear getStats shutdown

Constructors

constructor

new CacheStoreCache(store: CacheStore, clock?: Clock | null): CacheStoreCache
Parameters
- store: CacheStore
- clock: Clock | null = null
Returns CacheStoreCache
- Defined in src/core/cache/CacheStoreCache.ts:30

Methods

get

get(url: string): CacheEntry | null
Parameters
- url: string
Returns CacheEntry | null
Implementation of ICache.get
- Defined in src/core/cache/CacheStoreCache.ts:35

getETag

getETag(url: string): string | null
Parameters
- url: string
Returns string | null
Implementation of ICache.getETag
- Defined in src/core/cache/CacheStoreCache.ts:55

set

set(
    url: string,
    etag: string,
    data: unknown,
    headers: Record<string, string>,
    customTtl?: number,
): void
Parameters
- url: string
- etag: string
- data: unknown
- headers: Record<string, string>
- OptionalcustomTtl: number
Returns void
Implementation of ICache.set
- Defined in src/core/cache/CacheStoreCache.ts:59

has

has(url: string): boolean
Parameters
- url: string
Returns boolean
Implementation of ICache.has
- Defined in src/core/cache/CacheStoreCache.ts:76

delete

delete(url: string): boolean
Parameters
- url: string
Returns boolean
Implementation of ICache.delete
- Defined in src/core/cache/CacheStoreCache.ts:80

deleteByPath

deleteByPath(pathSegment: string): number
Parameters
- pathSegment: string
Returns number
Implementation of ICache.deleteByPath
- Defined in src/core/cache/CacheStoreCache.ts:85

clear

clear(): void
Returns void
Implementation of ICache.clear
- Defined in src/core/cache/CacheStoreCache.ts:95

getStats

getStats(): {
    totalEntries: number;
    maxEntries: number;
    hits: number;
    misses: number;
    hitRate: number;
    oldestEntry: number
    | null;
    newestEntry: number | null;
}
This runtime's view of the store: the keys it wrote that it has not seen expire, and its own hits and misses. maxEntries is 0, since the store sets its own bound; the entry ages are not tracked.

Returns {
    totalEntries: number;
    maxEntries: number;
    hits: number;
    misses: number;
    hitRate: number;
    oldestEntry: number | null;
    newestEntry: number | null;
}
Implementation of ICache.getStats
- Defined in src/core/cache/CacheStoreCache.ts:107

shutdown

shutdown(): void
Returns void
Implementation of ICache.shutdown
- Defined in src/core/cache/CacheStoreCache.ts:120

Class CacheStoreCache

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CacheStoreCache

Methods

get

Parameters

Returns CacheEntry | null

getETag

Parameters

Returns string | null

set

Parameters

Returns void

has

Parameters

Returns boolean

delete

Parameters

Returns boolean

deleteByPath

Parameters

Returns number

clear

Returns void

getStats

Returns {
    totalEntries: number;
    maxEntries: number;
    hits: number;
    misses: number;
    hitRate: number;
    oldestEntry: number | null;
    newestEntry: number | null;
}

shutdown

Returns void

Settings

On This Page

Class CacheStoreCache

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CacheStoreCache

Methods

get

Parameters

Returns CacheEntry | null

getETag

Parameters

Returns string | null

set

Parameters

Returns void

has

Parameters

Returns boolean

delete

Parameters

Returns boolean

deleteByPath

Parameters

Returns number

clear

Returns void

getStats

Returns { totalEntries: number; maxEntries: number; hits: number; misses: number; hitRate: number; oldestEntry: number | null; newestEntry: number | null;}

shutdown

Returns void

Settings

On This Page

Returns {
totalEntries: number;
maxEntries: number;
hits: number;
misses: number;
hitRate: number;
oldestEntry: number | null;
newestEntry: number | null;
}