callOnce
在 SSR 或 CSR 期间仅运行一次给定的函数或代码块。
此工具自 Nuxt v3.9 起可用。
目的
callOnce 函数旨在仅在以下情况下执行给定的函数或代码块一次：
- 服务器端渲染但不包括水合
- 客户端导航
这对于只需执行一次的代码非常有用，例如记录事件或设置全局状态。
用法
callOnce 的默认模式是仅运行一次代码。例如，如果代码在服务器上运行，它将不会在客户端再次运行。如果您在客户端多次调用 callOnce，例如通过导航回到此页面，它也不会再次运行。
app.vue
const websiteConfig = useState('config')
await callOnce(async () => {
console.log('这将只记录一次')
websiteConfig.value = await $fetch('https://my-cms.com/api/website-config')
})也可以在每次导航时运行，同时避免初始服务器/客户端的双重加载。为此，可以使用 navigation 模式：
app.vue
const websiteConfig = useState('config')
await callOnce(async () => {
console.log('这将只记录一次，然后在每次客户端导航时记录')
websiteConfig.value = await $fetch('https://my-cms.com/api/website-config')
}, { mode: 'navigation' })navigation 模式自 Nuxt v3.15 起可用。
callOnce 与 Pinia 模块 结合使用以调用存储动作非常有用。
请注意，callOnce 不返回任何内容。如果您想在 SSR 期间进行数据获取，应该使用 useAsyncData 或 useFetch。
callOnce 是一个可组合的函数，旨在直接在 setup 函数、插件或路由中间件中调用，因为它需要将数据添加到 Nuxt payload 中，以避免在页面水合时在客户端重新调用该函数。
类型
callOnce (key?: string, fn?: (() => any | Promise<any>), options?: CallOnceOptions): Promise<void>
callOnce(fn?: (() => any | Promise<any>), options?: CallOnceOptions): Promise<void>
type CallOnceOptions = {
/**
* callOnce 函数的执行模式
* @default 'render'
*/
mode?: 'navigation' | 'render'
}
参数
key: 确保代码仅运行一次的唯一键。如果您不提供键，则会为您生成一个唯一的键，该键与callOnce实例的文件和行号相关。fn: 要运行一次的函数。它可以是异步的。options: 设置模式，可以选择在导航时重新执行（navigation）或仅在应用程序的生命周期内执行一次（render）。默认为render。render: 在初始渲染期间执行一次（无论是 SSR 还是 CSR） - 默认模式navigation: 在初始渲染期间执行一次，并在每次后续的客户端导航时执行一次