NNext.js 中文网 GitHub

refresh

refresh 函数的 API 参考。

refresh 从 Server Action 重新运行当前路由的动态工作,而不会使服务端缓存数据失效。

用法#

refresh 只能从 Server Actions 中调用。在 Client Components 中使用 router.refresh()。它不能用于 Route Handlers 或其他上下文。

客户端缓存行为#

调用 refresh 会清除为前进/后退导航保留的页面,但不会使其他预取路由失效。在 Server Action 之前预取的路由可以复用,直到其过期时间到期。

如果变更操作修改了其他路由使用的缓存数据,请在 Server Action 中调用 updateTag 或 revalidatePath。这些函数会使服务端缓存数据失效,并且目前还会从客户端缓存中清除预取的路由。

参数#

tsx
refresh(): void;

返回值#

refresh 不返回任何值。

示例#

app/actions.ts
'use server'

import { refresh } from 'next/cache'

export async function createPost(formData: FormData) {
  const title = formData.get('title')
  const content = formData.get('content')

  // 在数据库中创建文章
  const post = await db.post.create({
    data: { title, content },
  })

  refresh()
}
app/actions.js
'use server'

import { refresh } from 'next/cache'

export async function createPost(formData) {
  const title = formData.get('title')
  const content = formData.get('content')

  // 在数据库中创建文章
  const post = await db.post.create({
    data: { title, content },
  })

  refresh()
}

在 Server Actions 之外使用时出错#

app/api/posts/route.ts
import { refresh } from 'next/cache'

export async function POST() {
  // 这将抛出一个错误
  refresh()
}
Next.js 中文网