---
title: "clearNuxtState"
description: "删除 useState 的缓存状态。"
canonical_url: "https://nuxt.zhcndoc.com/docs/4.x/api/utils/clear-nuxt-state"
---
# clearNuxtState

> 删除 useState 的缓存状态。

::note
此方法在你想使 `useState` 的状态失效时很有用。你也可以通过传入第二个参数 `{ reset: true }` 来将状态重置为初始值。
::

## 类型

```ts [Signature]
export function clearNuxtState (keys?: string | string[] | ((key: string) => boolean), opts?: ClearNuxtStateOptions): void
```

## 参数

- `keys`：在 [`useState`](https://nuxt.zhcndoc.com/docs/4.x/api/composables/use-state) 中使用的一个或多个键，用于删除其缓存状态。如果未提供键，则会使**所有状态**失效。
- `opts`：用于配置清除行为的选项对象。
  - `reset` :badge[v4.4]{color="info" size="xs" .align-middle}`：设为 `true` 时，会将状态重置为 [`useState`](/docs/api/composables/use-state) 的 `init`函数提供的初始值，而不是将其设为`undefined`。未指定时，默认采用 Nuxt 配置中 `experimental.defaults.useState.resetOnClear`的值（在`compatibilityVersion: 5`时为`true`）。`

---

- [源码](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/state.ts)


## Sitemap

See the full [sitemap](https://nuxt.zhcndoc.com/sitemap.md) for all pages.