refreshNuxtData

在 Nuxt 中刷新所有或特定的 asyncData 实例

refreshNuxtData 用于重新获取所有或特定的 asyncData 实例,包括来自 useAsyncDatauseLazyAsyncDatauseFetch 以及 useLazyFetch 的数据。

如果你的组件被 <KeepAlive> 缓存并进入停用状态,组件内的 asyncData 仍会被重新获取,直到组件被卸载。

类型

refreshNuxtData(keys?: string | string[])

参数

  • keys:用于获取数据的单个字符串或字符串数组的 keys。此参数为可选。如果未显式指定 keys,则会重新获取所有 useAsyncDatauseFetch 的 key。

返回值

refreshNuxtData 返回一个 Promise,当所有或特定的 asyncData 实例刷新完成时解析。

示例

刷新所有数据

以下示例刷新 Nuxt 应用中通过 useAsyncDatauseFetch 获取的所有数据。

pages/some-page.vue
<script setup lang="ts">
const refreshing = ref(false)

async function refreshAll () {
  refreshing.value = true
  try {
    await refreshNuxtData()
  } finally {
    refreshing.value = false
  }
}
</script>

<template>
  <div>
    <button :disabled="refreshing" @click="refreshAll">
      重新获取所有数据
    </button>
  </div>
</template>

刷新特定数据

以下示例仅刷新键名匹配 countuser 的数据。

pages/some-page.vue
<script setup lang="ts">
const refreshing = ref(false)

async function refresh () {
  refreshing.value = true
  try {
    // 你也可以传入多个键的数组来刷新多条数据
    await refreshNuxtData(['count', 'user'])
  } finally {
    refreshing.value = false
  }
}
</script>

<template>
  <div v-if="refreshing">
    加载中
  </div>
  <button @click="refresh">刷新</button>
</template>
如果你能访问到 asyncData 实例,建议通过其 refreshexecute 方法来重新获取数据,这是一种更优的方式。
Read more in Docs > Getting Started > Data Fetching.