Interface CacheStore

interface CacheStore {
    get(key: string): CachedResponse | null;
    set(
        key: string,
        etag: string,
        data: unknown,
        headers: Record<string, string>,
        ttlMs?: number,
    ): void;
    delete(key: string): boolean;
    clear(): void;
    shutdown(): void;
}

Index

Methods

get set delete clear shutdown

Methods

get

get(key: string): CachedResponse | null
The entry for key, or null when there is none or it has expired.
Parameters
- key: string
Returns CachedResponse | null
- Defined in src/core/ports/CacheStore.ts:25

set

set(
    key: string,
    etag: string,
    data: unknown,
    headers: Record<string, string>,
    ttlMs?: number,
): void
Parameters
- key: string
- etag: string
- data: unknown
- headers: Record<string, string>
- OptionalttlMs: number
  Retention in milliseconds, as for CachedResponse.ttl.
Returns void
- Defined in src/core/ports/CacheStore.ts:26

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
- Defined in src/core/ports/CacheStore.ts:34

clear

clear(): void
Returns void
- Defined in src/core/ports/CacheStore.ts:35

shutdown

shutdown(): void
Releases timers and connections; the store is not used afterwards.

Returns void
- Defined in src/core/ports/CacheStore.ts:37

Interface CacheStore

Index

Methods

Methods

get

Parameters

Returns CachedResponse | null

set

Parameters

Returns void

delete

Parameters

Returns boolean

clear

Returns void

shutdown

Returns void

Settings

On This Page