API Documentation / @pinia/colada / DefineQueryOptions

Type Alias: DefineQueryOptions<TData, TError, TDataInitial>

type DefineQueryOptions<TData, TError, TDataInitial> = _RemoveMaybeRef<UseQueryOptions<TData, TError, TDataInitial>> & object;

Options to define a query with defineQuery(). Similar to UseQueryOptions but disallows reactive values as defineQuery() is used outside of an effect scope.

Type declaration

initialData()?

optional initialData: () => TDataInitial;

Returns

TDataInitial

placeholderData?

optional placeholderData: 
  | NoInfer<TDataInitial>
  | NoInfer<TData>
  | <T>(previousData) => NoInfer<TDataInitial> | NoInfer<TData> | undefined;

Type Parameters

TData

TData = unknown

TError

TError = ErrorDefault

TDataInitial

TDataInitial extends TData | undefined = undefined