Skip to content

Custom Next.js Cache Handler

You can configure the Next.js cache location if you want to persist cached pages and data to durable storage, or share the cache across multiple containers or instances of your Next.js application.

next.config.js
module.exports = {
  cacheHandler: require.resolve('./cache-handler.js'),
  cacheMaxMemorySize: 0, // disable default in-memory caching
}

View an example of a custom cache handler and learn more about the implementation.

API Reference

The cache handler can implement the following methods: get, set, revalidateTag, and resetRequestCache.

get()

ParameterTypeDescription
keystringThe key to the cached value.

Returns the cached value or null if not found.

set()

ParameterTypeDescription
keystringThe key to store the data under.
dataData or nullThe data to be cached.
ctx{ tags: [] }The cache tags provided.

Returns Promise<void>.

revalidateTag()

ParameterTypeDescription
tagstring or string[]The cache tags to revalidate.

Returns Promise<void>. Learn more about revalidating data or the revalidateTag() function.

resetRequestCache()

This method resets the temporary in-memory cache for a single request before the next request.

Returns void.

Good to know:

  • revalidatePath is a convenience layer on top of cache tags. Calling revalidatePath will call your revalidateTag function, which you can then choose if you want to tag cache keys based on the path.

Platform Support

Deployment OptionSupported
Node.js serverYes
Docker containerYes
Static exportNo
AdaptersPlatform-specific

Learn how to configure ISR when self-hosting Next.js.

Version History

VersionChanges
v14.1.0Renamed to cacheHandler and became stable.
v13.4.0incrementalCacheHandlerPath support for revalidateTag.
v13.4.0incrementalCacheHandlerPath support for standalone output.
v12.2.0Experimental incrementalCacheHandlerPath added.