Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-11 08:33:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): improve useFetch docs for body type and additional ohmyfetch options (#4985)

Browse Source 
Co-authored-by: Sébastien Chopin <seb@nuxtjs.com>
Co-authored-by: pooya parsa <pyapar@gmail.com>
This commit is contained in:
Arthur 2022-05-20 11:04:37 +02:00 committed by GitHub
parent 36ad29a67c
commit 2a43cb4130
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/content/3.api/1.composables/use-fetch.md
View File

@ -13,6 +13,7 @@ function useFetch(
type UseFetchOptions = { type UseFetchOptions = {
method?: string, method?: string,
params?: SearchParams, params?: SearchParams,
body?: RequestInit['body'] | Record<string, any>
headers?: {key: string, value: string}[], headers?: {key: string, value: string}[],
baseURL?: string, baseURL?: string,
server?: boolean server?: boolean
@ -33,9 +34,10 @@ type DataT = {
## Params ## Params
* **Url**: The URL to fetch * **Url**: The URL to fetch
* **Options (from [ohmyfetch](https://github.com/unjs/ohmyfetch))**: * **Options (extends [unjs/ohmyfetch](https://github.com/unjs/ohmyfetch) options & [AsyncDataOptions](/api/composables/use-async-data#params))**:
* `method`: Request method * `method`: Request method
* `params`: Query params * `params`: Query params
* `body`: Request body - automatically stringified (if an object is passed).
* `headers`: Request headers * `headers`: Request headers
* `baseURL`: Base URL for the request * `baseURL`: Base URL for the request
* **Options (from `useAsyncData`)**: * **Options (from `useAsyncData`)**: