useFetch

这个组合式函数为 useAsyncData 和 $fetch 提供了一个方便的包装器。它会自动根据 URL 和获取选项生成 key，基于服务器路由为请求 URL 提供类型提示，并推断 API 响应类型。

用法

<script setup lang="ts">
const { data, status, error, refresh, clear } = await useFetch('/api/modules', {
  pick: ['title']
})
</script>

使用 query 选项，您可以向查询中添加搜索参数。此选项扩展自 unjs/ofetch，并使用 unjs/ufo 创建 URL。对象会被自动字符串化。

const param1 = ref('value1')
const { data, status, error, refresh } = await useFetch('/api/modules', {
  query: { param1, param2: 'value2' }
})

上面的示例结果为 https://api.nuxt.com/modules?param1=value1&param2=value2。

您还可以使用 拦截器。

const { data, status, error, refresh, clear } = await useFetch('/api/auth/login', {
  onRequest({ request, options }) {
    // Set the request headers
    // note that this relies on ofetch >= 1.4.0 - you may need to refresh your lockfile
    options.headers.set('Authorization', '...')
  },
  onRequestError({ request, options, error }) {
    // Handle the request errors
  },
  onResponse({ request, response, options }) {
    // Process the response data
    localStorage.setItem('token', response._data.token)
  },
  onResponseError({ request, response, options }) {
    // Handle the response errors
  }
})

参数

• URL：要获取的 URL。
• Options（扩展自 unjs/ofetch 选项 & AsyncDataOptions）
  • method：请求方法。
  • query：使用 ufo 向 URL 添加查询搜索参数。
  • params：query 的别名。
  • body：请求体 - 自动字符串化（如果传递的是对象）。
  • headers：请求头。
  • baseURL：请求的基本 URL。
  • timeout：自动中止请求的毫秒数。
  • cache：根据 Fetch API 处理缓存控制。
    • 您可以传递布尔值来禁用缓存，也可以传递以下值之一：default、no-store、reload、no-cache、force-cache 和 only-if-cached。

• Options（来自 useAsyncData）
  • key：确保跨请求正确去重数据获取的唯一键。如果未提供，将根据 URL 和 fetch 选项自动生成。
  • server：是否在服务器上获取数据（默认为 true）。
  • lazy：是否在加载路由后解析异步函数，而不是阻止客户端导航（默认为 false）。
  • immediate：设置为 false 时，将阻止请求立即触发。（默认为 true）
  • default：一个工厂函数，用于设置 data 的默认值，在异步函数解析之前 - 对于 lazy: true 或 immediate: false 选项很有用。
  • transform：一个函数，可用于在解析后更改 handler 函数的结果。
  • getCachedData：提供一个返回缓存数据的函数。null 或 undefined 返回值将触发获取。默认情况下，这是：key => nuxt.isHydrating ? nuxt.payload.data[key] : nuxt.static.data[key]，仅在启用 payloadExtraction 时缓存数据。
  • pick：仅从此数组中的 handler 函数结果中选择指定的键。
  • watch：监视响应式源数组，并在它们发生更改时自动刷新 fetch 结果。默认情况下，fetch 选项和 URL 会被监视。您可以使用 watch: false 完全忽略响应式源。与 immediate: false 一起使用时，允许完全手动使用 useFetch。（您可以在这里查看使用 watch 的示例。）
  • deep：在深层 ref 对象中返回数据（默认为 true）。可以设置为 false 以在浅层 ref 对象中返回数据，如果您的数据不需要深度响应，这可以提高性能。
  • dedupe：避免一次获取相同 key 多次（默认为 cancel）。可能的选项
    • cancel - 在发出新请求时取消现有请求。
    • defer - 如果有待处理的请求，则根本不发出新请求。

返回值

• data：传入的异步函数的结果。
• refresh/ execute：一个函数，可用于刷新 handler 函数返回的数据。
• error：如果数据获取失败，则会显示错误对象。
• status：一个字符串，指示数据请求的状态（"idle"、"pending"、"success"、"error"）。
• clear：一个函数，它会将 data 设置为 undefined，将 error 设置为 null，将 status 设置为 'idle'，并将任何当前挂起的请求标记为已取消。

默认情况下，Nuxt 会等到 refresh 完成后才能再次执行。

类型

function useFetch<DataT, ErrorT>(
  url: string | Request | Ref<string | Request> | (() => string) | Request,
  options?: UseFetchOptions<DataT>
): Promise<AsyncData<DataT, ErrorT>>

type UseFetchOptions<DataT> = {
  key?: string
  method?: string
  query?: SearchParams
  params?: SearchParams
  body?: RequestInit['body'] | Record<string, any>
  headers?: Record<string, string> | [key: string, value: string][] | Headers
  baseURL?: string
  server?: boolean
  lazy?: boolean
  immediate?: boolean
  getCachedData?: (key: string, nuxtApp: NuxtApp) => DataT
  deep?: boolean
  dedupe?: 'cancel' | 'defer'
  default?: () => DataT
  transform?: (input: DataT) => DataT | Promise<DataT>
  pick?: string[]
  watch?: WatchSource[] | false
}

type AsyncData<DataT, ErrorT> = {
  data: Ref<DataT | null>
  refresh: (opts?: AsyncDataExecuteOptions) => Promise<void>
  execute: (opts?: AsyncDataExecuteOptions) => Promise<void>
  clear: () => void
  error: Ref<ErrorT | null>
  status: Ref<AsyncDataRequestStatus>
}

interface AsyncDataExecuteOptions {
  dedupe?: 'cancel' | 'defer'
}

type AsyncDataRequestStatus = 'idle' | 'pending' | 'success' | 'error'