API Documentation / @pinia/colada / PiniaColadaQueryHooksPluginOptions
Interface: PiniaColadaQueryHooksPluginOptions
Options for PiniaColadaQueryHooksPlugin.
Properties
onError?
ts
optional onError?: <TError>(error, entry) => unknown;Global error handler for all queries.
Type Parameters
TError
TError = unknown
Parameters
error
TError
error thrown
entry
UseQueryEntry<unknown, TError>
Returns
unknown
onSettled?
ts
optional onSettled?: <TData, TError>(data, error, entry) => unknown;Global handler for when a query is settled (either successfully or with an error). Will await for the onSuccess or onError handlers to resolve if they return a promise.
Type Parameters
TData
TData = unknown
TError
TError = unknown
Parameters
data
TData | undefined
data returned by the query if any
error
TError | null
error thrown if any
entry
UseQueryEntry<TData, TError>
Returns
unknown
onSuccess?
ts
optional onSuccess?: <TData>(data, entry) => unknown;Global handler for when a query is successful.
Type Parameters
TData
TData = unknown
Parameters
data
TData
data returned by the query
entry
UseQueryEntry<TData, unknown>
Returns
unknown