API Documentation / @pinia/colada / useQueryState
Function: useQueryState()
Call Signature
ts
function useQueryState<TData, TError, TDataInitial>(key): UseQueryStateReturn<TData, TError, TDataInitial>;Reactive access to the state of a query entry without fetching it.
Type Parameters
TData
TData
TError
TError = { custom: Error; }
TDataInitial
TDataInitial = undefined
Parameters
key
MaybeRefOrGetter<EntryKeyTagged<TData, TError, TDataInitial>>
tagged key of the query entry to access
Returns
UseQueryStateReturn<TData, TError, TDataInitial>
Call Signature
ts
function useQueryState<TData, TError, TDataInitial>(key): UseQueryStateReturn<TData, TError, TDataInitial>;Reactive access to the state of a query entry without fetching it.
Type Parameters
TData
TData
TError
TError = { custom: Error; }
TDataInitial
TDataInitial = undefined
Parameters
key
MaybeRefOrGetter<EntryKey>
key of the query entry to access
Returns
UseQueryStateReturn<TData, TError, TDataInitial>