API Documentation / @pinia/colada / useQuery

Function: useQuery()

function useQuery<TData, TError, TDataInitial>(options): UseQueryReturn<TData, TError, TDataInitial>;

Ensures and return a shared query state based on the key option.

Type Parameters

TData

TData

TError

TError = { custom: Error; }

TDataInitial

TDataInitial = undefined

Parameters

options

| UseQueryOptions<TData, TError, TDataInitial> | (() => DefineQueryOptions<TData, TError, TDataInitial>)

The options of the query

Returns

UseQueryReturn<TData, TError, TDataInitial>

Example

const { state } = useQuery({
  key: ['documents'],
  query: () => getDocuments(),
})