useLazyFetch

源代码
这是对 useFetch 的封装，通过设置 `lazy` 选项为 `true`，会立即触发导航。

useLazyFetch 是对 useFetch 的封装，通过将 lazy 选项设置为 true，使得在处理函数解析之前立即触发导航。

用法

默认情况下，useFetch 会阻塞导航，直到其异步处理函数解析完成。而 useLazyFetch 则允许导航立即进行，数据在后台异步获取。

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

<template>
  <div v-if="status === 'pending'">
    加载中 ...
  </div>
  <div v-else>
    <div v-for="post in posts">
      <!-- 在此处理 -->
    </div>
  </div>
</template>
useLazyFetch 拥有和 useFetch 相同的签名。
等待 useLazyFetch 仅保证了调用初始化。在客户端导航时，数据可能不会立即可用，因此你必须在组件模板中处理 pending 状态。
useLazyFetch 是编译器保留的函数名，因此不要自行命名函数为 useLazyFetch。

类型

Signature
export function useLazyFetch<DataT, ErrorT> (
  url: string | Request | Ref<string | Request> | (() => string | Request),
  options?: UseFetchOptions<DataT>,
): Promise<AsyncData<DataT, ErrorT>>
useLazyFetch 等同于设置了 lazy: true 选项的 useFetch。完整的类型定义请参考 useFetch。

参数

useLazyFetch 接受和 useFetch 相同的参数：

  • URL（string | Request | Ref<string | Request> | () => string | Request）：要请求的 URL 或请求对象。
  • options（对象）：同 useFetch 选项，但 lazy 会自动设为 true。
在 Docs > 3 X > API > Composables > Use Fetch#parameters 中查看详情

返回值

返回与 useFetch 相同的 AsyncData 对象：

名称类型描述
dataRef<DataT | undefined>异步请求的结果数据。
refresh(opts?: AsyncDataExecuteOptions) => Promise<void>手动刷新数据的函数。
execute(opts?: AsyncDataExecuteOptions) => Promise<void>refresh 的别名。
errorRef<ErrorT | undefined>若请求失败，返回错误对象。
statusRef<'idle' | 'pending' | 'success' | 'error'>请求的当前状态。
clear() => void将 data 和 error 重置为 undefined，状态设为 idle，并取消所有挂起的请求。
在 Docs > 3 X > API > Composables > Use Fetch#return Values 中查看详情

示例

处理挂起状态

pages/index.vue
<script setup lang="ts">
/* 导航会在请求完成前发生。
 * 在组件模板中直接处理 'pending' 和 'error' 状态
 */
const { status, data: posts } = await useLazyFetch('/api/posts')
watch(posts, (newPosts) => {
  // 由于 posts 可能初始为 null，你无法马上访问其内容，但可以通过 watch 监听其变化。
})
</script>

<template>
  <div v-if="status === 'pending'">
    加载中 ...
  </div>
  <div v-else>
    <div v-for="post in posts">
      <!-- 在此处理 -->
    </div>
  </div>
</template>
在 Docs > 3 X > Getting Started > Data Fetching 中查看详情