79 lines
3.0 KiB
TypeScript
79 lines
3.0 KiB
TypeScript
|
import type { CacheFs } from '../../../shared/lib/utils';
|
||
|
|
import type { PrerenderManifest } from '../../../build';
|
||
|
|
import type { IncrementalCacheValue, IncrementalCacheEntry } from '../../response-cache';
|
||
|
|
export interface CacheHandlerContext {
|
||
|
|
fs?: CacheFs;
|
||
|
|
dev?: boolean;
|
||
|
|
flushToDisk?: boolean;
|
||
|
|
serverDistDir?: string;
|
||
|
|
maxMemoryCacheSize?: number;
|
||
|
|
fetchCacheKeyPrefix?: string;
|
||
|
|
prerenderManifest?: PrerenderManifest;
|
||
|
|
revalidatedTags: string[];
|
||
|
|
_appDir: boolean;
|
||
|
|
_requestHeaders: IncrementalCache['requestHeaders'];
|
||
|
|
}
|
||
|
|
export interface CacheHandlerValue {
|
||
|
|
lastModified?: number;
|
||
|
|
age?: number;
|
||
|
|
cacheState?: string;
|
||
|
|
value: IncrementalCacheValue | null;
|
||
|
|
}
|
||
|
|
export declare class CacheHandler {
|
||
|
|
constructor(_ctx: CacheHandlerContext);
|
||
|
|
get(..._args: Parameters<IncrementalCache['get']>): Promise<CacheHandlerValue | null>;
|
||
|
|
set(..._args: Parameters<IncrementalCache['set']>): Promise<void>;
|
||
|
|
revalidateTag(_tag: string): Promise<void>;
|
||
|
|
}
|
||
|
|
export declare class IncrementalCache {
|
||
|
|
dev?: boolean;
|
||
|
|
cacheHandler?: CacheHandler;
|
||
|
|
prerenderManifest: PrerenderManifest;
|
||
|
|
requestHeaders: Record<string, undefined | string | string[]>;
|
||
|
|
requestProtocol?: 'http' | 'https';
|
||
|
|
allowedRevalidateHeaderKeys?: string[];
|
||
|
|
minimalMode?: boolean;
|
||
|
|
fetchCacheKeyPrefix?: string;
|
||
|
|
revalidatedTags?: string[];
|
||
|
|
isOnDemandRevalidate?: boolean;
|
||
|
|
private locks;
|
||
|
|
private unlocks;
|
||
|
|
constructor({ fs, dev, appDir, flushToDisk, fetchCache, minimalMode, serverDistDir, requestHeaders, requestProtocol, maxMemoryCacheSize, getPrerenderManifest, fetchCacheKeyPrefix, CurCacheHandler, allowedRevalidateHeaderKeys, }: {
|
||
|
|
fs?: CacheFs;
|
||
|
|
dev: boolean;
|
||
|
|
appDir?: boolean;
|
||
|
|
fetchCache?: boolean;
|
||
|
|
minimalMode?: boolean;
|
||
|
|
serverDistDir?: string;
|
||
|
|
flushToDisk?: boolean;
|
||
|
|
requestProtocol?: 'http' | 'https';
|
||
|
|
allowedRevalidateHeaderKeys?: string[];
|
||
|
|
requestHeaders: IncrementalCache['requestHeaders'];
|
||
|
|
maxMemoryCacheSize?: number;
|
||
|
|
getPrerenderManifest: () => PrerenderManifest;
|
||
|
|
fetchCacheKeyPrefix?: string;
|
||
|
|
CurCacheHandler?: typeof CacheHandler;
|
||
|
|
});
|
||
|
|
private calculateRevalidate;
|
||
|
|
_getPathname(pathname: string, fetchCache?: boolean): string;
|
||
|
|
unlock(cacheKey: string): Promise<void>;
|
||
|
|
lock(cacheKey: string): Promise<() => Promise<void>>;
|
||
|
|
revalidateTag(tag: string): Promise<any>;
|
||
|
|
fetchCacheKey(url: string, init?: RequestInit | Request): Promise<string>;
|
||
|
|
get(cacheKey: string, ctx?: {
|
||
|
|
fetchCache?: boolean;
|
||
|
|
revalidate?: number | false;
|
||
|
|
fetchUrl?: string;
|
||
|
|
fetchIdx?: number;
|
||
|
|
tags?: string[];
|
||
|
|
softTags?: string[];
|
||
|
|
}): Promise<IncrementalCacheEntry | null>;
|
||
|
|
set(pathname: string, data: IncrementalCacheValue | null, ctx: {
|
||
|
|
revalidate?: number | false;
|
||
|
|
fetchCache?: boolean;
|
||
|
|
fetchUrl?: string;
|
||
|
|
fetchIdx?: number;
|
||
|
|
tags?: string[];
|
||
|
|
}): Promise<any>;
|
||
|
|
}
|