docs(api): fix useAsyncData signature (#7242)

This commit is contained in:
Alex Kozack 2022-09-05 14:43:40 +03:00 committed by GitHub
parent 2db8fec006
commit 8a81f2ad90
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -18,19 +18,25 @@ function useAsyncData(
type AsyncDataOptions<DataT> = { type AsyncDataOptions<DataT> = {
server?: boolean server?: boolean
lazy?: boolean lazy?: boolean
default?: () => DataT | Ref<DataT> default?: () => DataT | Ref<DataT> | null
transform?: (input: DataT) => DataT transform?: (input: DataT) => DataT
pick?: string[] pick?: string[]
watch?: WatchSource[] watch?: WatchSource[]
initialCache?: boolean initialCache?: boolean
} }
type AsyncData<DataT> = { interface RefreshOptions {
data: Ref<DataT> _initial?: boolean
pending: Ref<boolean>
refresh: () => Promise<void>
error: Ref<any>
} }
type AsyncData<DataT, ErrorT> = {
data: Ref<DataT | null>
pending: Ref<boolean>
refresh: (opts?: RefreshOptions) => Promise<void>
error: Ref<ErrorT | null>
}
``` ```
## Params ## Params