useState

useState 组合式创建了一个响应式且对 SSR 友好的共享状态。

Maschinelle Übersetzung ·0 % geprüft

用法

// 创建一个响应式状态并设置默认值
const count = useState('counter', () => Math.round(Math.random() * 100))
Weitere Informationen findest du unter Docs > Getting Started > State Management.
因为 useState 内的数据会被序列化为 JSON,因此重要的是它不应包含任何无法被序列化的内容,例如类、函数或符号(classes、functions 或 symbols)。
useState 是一个由编译器转换的保留函数名,因此你不应该将自己的函数命名为 useState。

使用 shallowRef

如果你不需要状态深度响应,可以将 useState 与 shallowRef 结合使用。当你的状态包含大型对象和数组时,这可以提高性能。

const state = useState('my-shallow-state', () => shallowRef({ deep: 'not reactive' }))
// isShallow(state) === true

类型

Signatur
export function useState<T> (init?: () => T | Ref<T>): Ref<T>
export function useState<T> (key: string, init?: () => T | Ref<T>): Ref<T>
  • key:一个唯一的键,确保跨请求正确去重数据获取。如果你未提供键,则会为你生成一个对于 useState 实例所在文件和行号唯一的键。
  • init:当状态尚未初始化时,为其提供初始值的函数。此函数也可以返回一个 Ref。
  • T:(仅限 TypeScript)指定状态的类型

故障排除

无法序列化任意非普通 JavaScript 对象(non-POJOs)

当你尝试用 useState 存储不可序列化的负载(例如类的实例)时,会出现此错误。

如果你想使用 useState 存储 Nuxt 不支持的类实例,可以使用 definePayloadPlugin 为你的类添加自定义序列化器和反序列化器。

Weitere Informationen findest du unter Docs > API > Composables > Use Nuxt App#payload.