Incremental Static Regeneration (ISR) enables you to:
cache-control
headers are automatically added to pagesnext build
timesHere's a minimal example:
interface Post {
id: string
title: string
content: string
}
// Next.js will invalidate the cache when a
// request comes in, at most once every 60 seconds.
export const revalidate = 60
export async function generateStaticParams() {
const posts: Post[] = await fetch('https://api.vercel.app/blog').then((res) =>
res.json()
)
return posts.map((post) => ({
id: String(post.id),
}))
}
export default async function Page({
params,
}: {
params: Promise<{ id: string }>
}) {
const { id } = await params
const post: Post = await fetch(`https://api.vercel.app/blog/${id}`).then(
(res) => res.json()
)
return (
<main>
<h1>{post.title}</h1>
<p>{post.content}</p>
</main>
)
}
Here's how this example works:
next build
, all known blog posts are generated/blog/1
) are cached and instantaneous/blog/26
is requested, and it exists, the page will be generated on-demand. This behavior can be changed by using a different dynamicParams value. However, if the post does not exist, then 404 is returned.This fetches and displays a list of blog posts on /blog. After an hour has passed, the next visitor will still receive the cached (stale) version of the page immediately for a fast response. Simultaneously, Next.js triggers regeneration of a fresh version in the background. Once the new version is successfully generated, it replaces the cached version, and subsequent visitors will receive the updated content.
interface Post {
id: string
title: string
content: string
}
export const revalidate = 3600 // invalidate every hour
export default async function Page() {
const data = await fetch('https://api.vercel.app/blog')
const posts: Post[] = await data.json()
return (
<main>
<h1>Blog Posts</h1>
<ul>
{posts.map((post) => (
<li key={post.id}>{post.title}</li>
))}
</ul>
</main>
)
}
We recommend setting a high revalidation time. For instance, 1 hour instead of 1 second. If you need more precision, consider using on-demand revalidation. If you need real-time data, consider switching to dynamic rendering.
On-demand revalidation withrevalidatePath
For a more precise method of revalidation, invalidate cached pages on-demand with the revalidatePath
function.
For example, this Server Action would get called after adding a new post. Regardless of how you retrieve your data in your Server Component, either using fetch
or connecting to a database, this will invalidate the cache for the entire route. The next request to that route will trigger regeneration and serve fresh data, which will then be cached for subsequent requests.
Note:
revalidatePath
invalidates the cache entries but regeneration happens on the next request. If you want to eagerly regenerate the cache entry immediately instead of waiting for the next request, you can use the Pages routerres.revalidate
method. We're working on adding new methods to provide eager regeneration capabilities for the App Router.
'use server'
import { revalidatePath } from 'next/cache'
export async function createPost() {
// Invalidate the cache for the /posts route
revalidatePath('/posts')
}
View a demo and explore the source code .
On-demand revalidation withrevalidateTag
For most use cases, prefer revalidating entire paths. If you need more granular control, you can use the revalidateTag
function. For example, you can tag individual fetch
calls:
export default async function Page() {
const data = await fetch('https://api.vercel.app/blog', {
next: { tags: ['posts'] },
})
const posts = await data.json()
// ...
}
If you are using an ORM or connecting to a database, you can use unstable_cache
:
import { unstable_cache } from 'next/cache'
import { db, posts } from '@/lib/db'
const getCachedPosts = unstable_cache(
async () => {
return await db.select().from(posts)
},
['posts'],
{ revalidate: 3600, tags: ['posts'] }
)
export default async function Page() {
const posts = getCachedPosts()
// ...
}
You can then use revalidateTag
in a Server Actions or Route Handler:
'use server'
import { revalidateTag } from 'next/cache'
export async function createPost() {
// Invalidate all data tagged with 'posts'
revalidateTag('posts')
}
Handling uncaught exceptions
If an error is thrown while attempting to revalidate data, the last successfully generated data will continue to be served from the cache. On the next subsequent request, Next.js will retry revalidating the data. Learn more about error handling.
Customizing the cache locationYou 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. Learn more.
Troubleshooting Debugging cached data in local developmentIf you are using the fetch
API, you can add additional logging to understand which requests are cached or uncached. Learn more about the logging
option.
module.exports = {
logging: {
fetches: {
fullUrl: true,
},
},
}
Verifying correct production behavior
To verify your pages are cached and revalidated correctly in production, you can test locally by running next build
and then next start
to run the production Next.js server.
This will allow you to test ISR behavior as it would work in a production environment. For further debugging, add the following environment variable to your .env
file:
NEXT_PRIVATE_DEBUG_CACHE=1
This will make the Next.js server console log ISR cache hits and misses. You can inspect the output to see which pages are generated during next build
, as well as how pages are updated as paths are accessed on-demand.
fetch
requests in a statically rendered route, and each has a different revalidate
frequency, the lowest time will be used for ISR. However, those revalidate frequencies will still be respected by the Data Cache.fetch
requests used on a route have a revalidate
time of 0
, or an explicit no-store
, the route will be dynamically rendered./post/1
instead of a rewritten /post-1
.Learn how to configure ISR when self-hosting Next.js.
Version history Version Changesv14.1.0
Custom cacheHandler
is stable. v13.0.0
App Router is introduced. v12.2.0
Pages Router: On-Demand ISR is stable v12.0.0
Pages Router: Bot-aware ISR fallback added. v9.5.0
Pages Router: Stable ISR introduced.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4