Class IncrementalCache

constructor

• new IncrementalCache(__namedParameters): IncrementalCache

• Parameters

  • __namedParameters: {
        CurCacheHandler?: typeof CacheHandler;
        allowedRevalidateHeaderKeys?: string[];
        dev: boolean;
        fetchCacheKeyPrefix?: string;
        flushToDisk?: boolean;
        fs?: CacheFs;
        getPrerenderManifest: (() => {
            dynamicRoutes: {};
            notFoundRoutes: readonly string[];
            preview: {
                previewModeEncryptionKey: string;
                previewModeId: string;
                previewModeSigningKey: string;
            };
            routes: {};
            version: 4;
        });
        maxMemoryCacheSize?: number;
        minimalMode?: boolean;
        requestHeaders: Record<string, undefined | string | string[]>;
        serverDistDir?: string;
    }

    • Optional CurCacheHandler?: typeof CacheHandler

    • Optional allowedRevalidateHeaderKeys?: string[]

    • dev: boolean

    • Optional fetchCacheKeyPrefix?: string

    • Optional flushToDisk?: boolean

    • Optional fs?: CacheFs

    • getPrerenderManifest: (() => {
          dynamicRoutes: {};
          notFoundRoutes: readonly string[];
          preview: {
              previewModeEncryptionKey: string;
              previewModeId: string;
              previewModeSigningKey: string;
          };
          routes: {};
          version: 4;
      })

      • • (): {
              dynamicRoutes: {};
              notFoundRoutes: readonly string[];
              preview: {
                  previewModeEncryptionKey: string;
                  previewModeId: string;
                  previewModeSigningKey: string;
              };
              routes: {};
              version: 4;
          }

        • Returns {
              dynamicRoutes: {};
              notFoundRoutes: readonly string[];
              preview: {
                  previewModeEncryptionKey: string;
                  previewModeId: string;
                  previewModeSigningKey: string;
              };
              routes: {};
              version: 4;
          }

          • Readonly dynamicRoutes: {}

          • Readonly notFoundRoutes: readonly string[]

          • Readonly preview: {
                previewModeEncryptionKey: string;
                previewModeId: string;
                previewModeSigningKey: string;
            }

            • Readonly previewModeEncryptionKey: string

            • Readonly previewModeId: string

            • Readonly previewModeSigningKey: string

          • Readonly routes: {}

          • Readonly version: 4

    • Optional maxMemoryCacheSize?: number

    • Optional minimalMode?: boolean

    • requestHeaders: Record<string, undefined | string | string[]>

    • Optional serverDistDir?: string

  Returns IncrementalCache

Optional Readonly allowedRevalidateHeaderKeys

Optional Readonly cacheHandler

Optional Readonly dev

Optional Readonly disableForTestmode

Optional Readonly fetchCacheKeyPrefix

Readonly hasCustomCacheHandler

Optional Readonly isOnDemandRevalidate

Optional Readonly minimalMode

Readonly prerenderManifest

Readonly requestHeaders

Optional Readonly revalidatedTags

_getPathname

• _getPathname(pathname, fetchCache?): string

• Parameters

  • pathname: string

  • Optional fetchCache: boolean

  Returns string

generateCacheKey

• generateCacheKey(url, init?): Promise<string>

• Parameters

  • url: string

  • Optional init: RequestInit | Request

  Returns Promise<string>

get

• get(cacheKey, ctx): Promise<null | IncrementalFetchCacheEntry>

• Parameters

  • cacheKey: string

  • ctx: GetIncrementalFetchCacheContext

  Returns Promise<null | IncrementalFetchCacheEntry>

• get(cacheKey, ctx): Promise<null | IncrementalResponseCacheEntry>

• Parameters

  • cacheKey: string

  • ctx: GetIncrementalResponseCacheContext

  Returns Promise<null | IncrementalResponseCacheEntry>

lock

• lock(cacheKey): Promise<(() => void | Promise<void>)>

• Parameters

  • cacheKey: string

  Returns Promise<(() => void | Promise<void>)>

resetRequestCache

• resetRequestCache(): void

• Returns void

revalidateTag

• revalidateTag(tags, durations?): Promise<void>

• Parameters

  • tags: string | string[]

  • Optional durations: {
        expire?: number;
    }

    • Optional expire?: number

  Returns Promise<void>

set

• set(pathname, data, ctx): Promise<void>

• Parameters

  • pathname: string

  • data: null | CachedFetchValue

  • ctx: SetIncrementalFetchCacheContext

  Returns Promise<void>

• set(pathname, data, ctx): Promise<void>

• Parameters

  • pathname: string

  • data: null | CachedRedirectValue | IncrementalCachedPageValue | IncrementalCachedAppPageValue | CachedImageValue | CachedRouteValue

  • ctx: SetIncrementalResponseCacheContext

  Returns Promise<void>