Sanity Library Reference Docs
Preparing search index...
@sanity/react-loader
QueryStore
Interface QueryStore
interface
QueryStore
{
loadQuery
:
<
QueryResponseResult
>
(
query
:
string
,
params
?:
QueryParams
,
options
?:
Pick
<
ResponseQueryOptions
,
"perspective"
|
"cache"
|
"next"
|
"headers"
|
"useCdn"
|
"stega"
|
"tag"
,
>
,
)
=>
Promise
<
QueryResponseInitial
<
QueryResponseResult
>
>
;
setServerClient
:
(
client
:
SanityClient
|
SanityStegaClient
)
=>
void
;
useLiveMode
:
UseLiveModeHook
;
useQuery
:
{
<
QueryResponseResult
=
unknown
,
QueryResponseError
=
unknown
>
(
query
:
string
,
params
?:
QueryParams
,
options
?:
UseQueryOptionsUndefinedInitial
,
)
:
QueryStoreState
<
QueryResponseResult
,
QueryResponseError
>
&
WithEncodeDataAttribute
;
<
QueryResponseResult
=
unknown
,
QueryResponseError
=
unknown
>
(
query
:
string
,
params
?:
QueryParams
,
options
?:
UseQueryOptionsDefinedInitial
<
QueryResponseResult
>
,
)
:
Omit
<
QueryStoreState
<
QueryResponseResult
,
QueryResponseError
>
,
"data"
>
&
{
data
:
QueryResponseResult
;
}
&
WithEncodeDataAttribute
;
}
;
}
Index
Properties
load
Query
set
Server
Client
use
Live
Mode
use
Query
Properties
load
Query
loadQuery
:
<
QueryResponseResult
>
(
query
:
string
,
params
?:
QueryParams
,
options
?:
Pick
<
ResponseQueryOptions
,
"perspective"
|
"cache"
|
"next"
|
"headers"
|
"useCdn"
|
"stega"
|
"tag"
,
>
,
)
=>
Promise
<
QueryResponseInitial
<
QueryResponseResult
>
>
set
Server
Client
setServerClient
:
(
client
:
SanityClient
|
SanityStegaClient
)
=>
void
use
Live
Mode
useLiveMode
:
UseLiveModeHook
use
Query
useQuery
:
{
<
QueryResponseResult
=
unknown
,
QueryResponseError
=
unknown
>
(
query
:
string
,
params
?:
QueryParams
,
options
?:
UseQueryOptionsUndefinedInitial
,
)
:
QueryStoreState
<
QueryResponseResult
,
QueryResponseError
>
&
WithEncodeDataAttribute
;
<
QueryResponseResult
=
unknown
,
QueryResponseError
=
unknown
>
(
query
:
string
,
params
?:
QueryParams
,
options
?:
UseQueryOptionsDefinedInitial
<
QueryResponseResult
>
,
)
:
Omit
<
QueryStoreState
<
QueryResponseResult
,
QueryResponseError
>
,
"data"
>
&
{
data
:
QueryResponseResult
;
}
&
WithEncodeDataAttribute
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
load
Query
set
Server
Client
use
Live
Mode
use
Query
Sanity Library Reference Docs
Loading...