Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-12-02 02:17:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(useFetch): minor punctuation fixes (#6409)

Browse Source
This commit is contained in:
Timur Bolotov 2022-08-07 15:57:10 +06:00 committed by GitHub
parent ea868f5586
commit 34056d7176
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -11,12 +11,12 @@ function useFetch(
): Promise<AsyncData<DataT>> ): Promise<AsyncData<DataT>>
type UseFetchOptions = { type UseFetchOptions = {
key?: string, key?: string
method?: string, method?: string
params?: SearchParams, params?: SearchParams
body?: RequestInit['body'] | Record<string, any> body?: RequestInit['body'] | Record<string, any>
headers?: {key: string, value: string}[], headers?: { key: string, value: string }[]
baseURL?: string, baseURL?: string
server?: boolean server?: boolean
lazy?: boolean lazy?: boolean
default?: () => DataT default?: () => DataT
@ -36,21 +36,21 @@ type AsyncData<DataT> = {
## Params ## Params
* **Url**: The URL to fetch * **Url**: The URL to fetch.
* **Options (extends [unjs/ohmyfetch](https://github.com/unjs/ohmyfetch) options & [AsyncDataOptions](/api/composables/use-async-data#params))**: * **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). * `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`)**:
* `key`: a unique key to ensure that data fetching can be properly de-duplicated across requests, if not provided, it will be generated based on the `url` and fetch options * `key`: a unique key to ensure that data fetching can be properly de-duplicated across requests, if not provided, it will be generated based on the `url` and fetch options.
* `lazy`: Whether to resolve the async function after loading the route, instead of blocking navigation (defaults to `false`). * `lazy`: Whether to resolve the async function after loading the route, instead of blocking navigation (defaults to `false`).
* `server`: Whether to fetch the data on the server (defaults to `true`). * `server`: Whether to fetch the data on the server (defaults to `true`).
* `default`: A factory function to set the default value of the data, before the async function resolves - particularly useful with the `lazy: true` option. * `default`: A factory function to set the default value of the data, before the async function resolves - particularly useful with the `lazy: true` option.
* `pick`: Only pick specified keys in this array from the `handler` function result. * `pick`: Only pick specified keys in this array from the `handler` function result.
* `watch`: watch reactive sources to auto-refresh * `watch`: watch reactive sources to auto-refresh.
* `initialCache`: When set to `false`, will skip payload cache for initial fetch. (defaults to `true`) * `initialCache`: When set to `false`, will skip payload cache for initial fetch (defaults to `true`).
* `transform`: A function that can be used to alter `handler` function result after resolving. * `transform`: A function that can be used to alter `handler` function result after resolving.
::alert{type=warning} ::alert{type=warning}
@ -59,10 +59,10 @@ If you provide a function or ref as the `url` parameter, or if you provide funct
## Return values ## Return values
* **data**: the result of the asynchronous function that is passed in * **data**: the result of the asynchronous function that is passed in.
* **pending**: a boolean indicating whether the data is still being fetched * **pending**: a boolean indicating whether the data is still being fetched.
* **refresh**: a function that can be used to refresh the data returned by the `handler` function * **refresh**: a function that can be used to refresh the data returned by the `handler` function.
* **error**: an error object if the data fetching failed * **error**: an error object if the data fetching failed.
By default, Nuxt waits until a `refresh` is finished before it can be executed again. Passing `true` as parameter skips that wait. By default, Nuxt waits until a `refresh` is finished before it can be executed again. Passing `true` as parameter skips that wait.