Nuxt/docs/3.api/2.composables/use-lazy-fetch.md

1.5 KiB

title description links
useLazyFetch This wrapper around useFetch triggers navigation immediately.
label icon to size
Source i-simple-icons-github https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/fetch.ts xs

Description

By default, useFetch blocks navigation until its async handler is resolved. useLazyFetch provides a wrapper around useFetch that triggers navigation before the handler is resolved by setting the lazy option to true.

::note useLazyFetch has the same signature as useFetch. ::

:read-more{to="/docs/api/composables/use-fetch"}

Example

<script setup lang="ts">
/* Navigation will occur before fetching is complete.
 * Handle 'pending' and 'error' states directly within your component's template
 */
const { status, data: posts } = await useLazyFetch('/api/posts')
watch(posts, (newPosts) => {
  // Because posts might start out null, you won't have access
  // to its contents immediately, but you can watch it.
})
</script>

<template>
  <div v-if="status === 'pending'">
    Loading ...
  </div>
  <div v-else>
    <div v-for="post in posts">
      <!-- do something -->
    </div>
  </div>
</template>

::note useLazyFetch is a reserved function name transformed by the compiler, so you should not name your own function useLazyFetch. ::

:read-more{to="/docs/getting-started/data-fetching"}