Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: extend description of handler param for useAsyncData composable #23389

Merged
merged 3 commits into from
Sep 28, 2023
Merged

docs: extend description of handler param for useAsyncData composable #23389

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9bdb47
docs: extend description of `handler` param for useAsyncData composable
MaxKostenko Sep 24, 2023
c7fa468
docs: apply suggestion for handler description
MaxKostenko Sep 27, 2023
7bf0644
Merge branch 'main' into docs-extend-handler-param-description-use-as…
MaxKostenko Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/3.api/1.composables/use-async-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ type AsyncDataRequestStatus = 'idle' | 'pending' | 'success' | 'error'
## Params

* **key**: a unique key to ensure that data fetching can be properly de-duplicated across requests. If you do not provide a key, then a key that is unique to the file name and line number of the instance of [`useAsyncData`](/docs/api/composables/use-async-data) will be generated for you.
* **handler**: an asynchronous function that returns a value
* **handler**: an asynchronous function that must return a truthy value (for example, it should not be `undefined` or `null`) or the request may be duplicated on the client side
* **options**:
* _server_: whether to fetch the data on the server (defaults to `true`)
* _lazy_: whether to resolve the async function after loading the route, instead of blocking client-side navigation (defaults to `false`)
Expand Down