useLazyAsyncData

源码
这是对 useAsyncData 的一个封装,能够立即触发导航。

useLazyAsyncData 是对 useAsyncData 的一个封装,通过将 lazy 选项设置为 true,让导航在处理函数解析前即可触发。

默认情况下,useAsyncData 会阻止导航,直到其异步处理函数解析完毕。useLazyAsyncData 允许导航立即发生,同时数据获取在后台继续进行。

用法

app/pages/index.vue
<script setup lang="ts">
const { status, data: posts } = await useLazyAsyncData('posts', () => $fetch('/api/posts'))
</script>

<template>
  <div>
    <div v-if="status === 'pending'">
      加载中...
    </div>
    <div v-else-if="status === 'error'">
      加载帖子时出错
    </div>
    <div v-else>
      {{ posts }}
    </div>
  </div>
</template>

使用 useLazyAsyncData 时,导航会在数据获取完成前发生。这意味着你必须在组件模板内直接处理 pendingerror 状态。

useLazyAsyncData 是一个编译器会转换的保留函数名,因此你不应将自己的函数命名为 useLazyAsyncData

类型

Signature
export function useLazyAsyncData<DataT, ErrorT> (
  handler: (ctx?: NuxtApp) => Promise<DataT>,
  options?: AsyncDataOptions<DataT>,
): AsyncData<DataT, ErrorT>

export function useLazyAsyncData<DataT, ErrorT> (
  key: string,
  handler: (ctx?: NuxtApp) => Promise<DataT>,
  options?: AsyncDataOptions<DataT>,
): AsyncData<DataT, ErrorT>

useLazyAsyncData 拥有与 useAsyncData 相同的签名。

参数

useLazyAsyncData 接受与 useAsyncData 相同的参数,只是 lazy 选项会被自动设置为 true

Docs > 3 X > API > Composables > Use Async Data#parameters 中查看详情

返回值

useLazyAsyncData 返回与 useAsyncData 相同的值。

Docs > 3 X > API > Composables > Use Async Data#return Values 中查看详情

示例

pages/index.vue
<script setup lang="ts">
/* 导航会在数据获取完成之前执行。
   请在组件的模板中直接处理 'pending' 和 'error' 状态
*/
const { status, data: count } = await useLazyAsyncData('count', () => $fetch('/api/count'))

watch(count, (newCount) => {
  // 由于 count 可能一开始为 null,无法立即访问其内容,但你可以监听它的变化。
})
</script>

<template>
  <div>
    {{ status === 'pending' ? '加载中' : count }}
  </div>
</template>
Docs > 3 X > Getting Started > Data Fetching 中查看详情