Nuxt/docs/3.api/2.composables/use-lazy-fetch.md
2024-02-21 18:09:45 +01:00

52 lines
1.5 KiB
Markdown

---
title: 'useLazyFetch'
description: This wrapper around useFetch triggers navigation immediately.
links:
- label: Source
icon: i-simple-icons-github
to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/fetch.ts
size: xs
---
## Description
By default, [`useFetch`](/docs/api/composables/use-fetch) blocks navigation until its async handler is resolved. `useLazyFetch` provides a wrapper around [`useFetch`](/docs/api/composables/use-fetch) that triggers navigation before the handler is resolved by setting the `lazy` option to `true`.
::note
`useLazyFetch` has the same signature as [`useFetch`](/docs/api/composables/use-fetch).
::
:read-more{to="/docs/api/composables/use-fetch"}
## Example
```vue [pages/index.vue]
<script setup lang="ts">
/* Navigation will occur before fetching is complete.
Handle pending and error states directly within your component's template
*/
const { pending, 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="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"}