mirror of
https://github.com/hanzoai/next.js.git
synced 2026-10-30 14:46:38 +00:00
c2b4c0815c
This PRs unifies the caching story across the docs, making Cache Components the happy path, while still providing guidance to users in the old model. However, instead of explaining the old model and its caching layers, we've created a new guide focusing on what APIs to use and when. This follow-up PR aligns terminology across the docs: https://github.com/vercel/next.js/pull/90589 ## IA updates Getting Started section: - Improves Getting Started progression: - **Before:** CC → Fetching Data → Updating Data → Caching and Revalidating (old and new model mixed) - **After:** Fetching Data (Dynamic) → Mutating Data (Dynamic) → Caching with CC (Prerendering) → Revalidating with CC. - New: `caching.mdx` (CC-first) - Structure: - Enabling Cache Components - Data vs UI-level caching - Working with request time APIs - Passing request values to cached functions - Working with non-deterministic operations - Working with synchronous operations - How rendering works (PPR and static shell story) - New: `revalidating.mdx` (CC-first) - Explains how to use `cacheLife` and `cacheTag` Guides Section: - New: `caching-and-revalidating.mdx` (Previous Model) - For users who are not using CC, includes `fetch` options and route segment config - Moves route segment config options that don't apply to CC from API reference to this guide (for easy archiving in the future). - New: `migrating-to-cache-components.mdx` (WIP) - Del: `caching.mdx` 😌 ## Terminology We should remove caching layers from the docs. Users only needed to be exposed to them when they were configured independently, but the new CC APIs work across layers. To make it easier to review this PR, I'm consolidating terminology and fixing broken links in a new PR: https://github.com/vercel/next.js/pull/90589 --------- Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com> Co-authored-by: Joseph <[email protected]>
70 lines
1.3 KiB
Plaintext
70 lines
1.3 KiB
Plaintext
---
|
|
title: refresh
|
|
description: API Reference for the refresh function.
|
|
---
|
|
|
|
`refresh` allows you to refresh the client router from within a [Server Action](/docs/app/getting-started/mutating-data).
|
|
|
|
## Usage
|
|
|
|
`refresh` can **only** be called from within Server Actions. It cannot be used in Route Handlers, Client Components, or any other context.
|
|
|
|
## Parameters
|
|
|
|
```tsx
|
|
refresh(): void;
|
|
```
|
|
|
|
## Returns
|
|
|
|
`refresh` does not return a value.
|
|
|
|
## Examples
|
|
|
|
```ts filename="app/actions.ts" switcher
|
|
'use server'
|
|
|
|
import { refresh } from 'next/cache'
|
|
|
|
export async function createPost(formData: FormData) {
|
|
const title = formData.get('title')
|
|
const content = formData.get('content')
|
|
|
|
// Create the post in your database
|
|
const post = await db.post.create({
|
|
data: { title, content },
|
|
})
|
|
|
|
refresh()
|
|
}
|
|
```
|
|
|
|
```js filename="app/actions.js" switcher
|
|
'use server'
|
|
|
|
import { refresh } from 'next/cache'
|
|
|
|
export async function createPost(formData) {
|
|
const title = formData.get('title')
|
|
const content = formData.get('content')
|
|
|
|
// Create the post in your database
|
|
const post = await db.post.create({
|
|
data: { title, content },
|
|
})
|
|
|
|
refresh()
|
|
}
|
|
```
|
|
|
|
### Error when used outside Server Actions
|
|
|
|
```ts filename="app/api/posts/route.ts" switcher
|
|
import { refresh } from 'next/cache'
|
|
|
|
export async function POST() {
|
|
// This will throw an error
|
|
refresh()
|
|
}
|
|
```
|