Sanity Library Reference Docs
Preparing search index...
sanity
index
DocumentStore
Interface DocumentStore
Beta
Hidden
interface
DocumentStore
{
initialValue
:
(
opts
:
InitialValueOptions
,
context
:
InitialValueResolverContext
,
)
=>
Observable
<
InitialValueMsg
>
;
listenQuery
:
(
query
:
string
|
{
fetch
:
string
;
listen
:
string
}
,
params
:
QueryParams
,
options
:
ListenQueryOptions
,
)
=>
Observable
<
any
>
;
pair
:
{
consistencyStatus
:
(
publishedId
:
string
,
type
:
string
,
version
?:
string
,
)
=>
Observable
<
boolean
>
;
editState
:
(
publishedId
:
string
,
type
:
string
,
version
?:
string
,
)
=>
Observable
<
EditStateFor
>
;
operationEvents
:
(
publishedId
:
string
,
type
:
string
,
)
=>
Observable
<
OperationSuccess
|
OperationError
>
;
validation
:
(
validationTargetId
:
string
,
type
:
string
,
validatePublishedReferences
:
boolean
,
)
=>
Observable
<
ValidationStatus
>
;
}
;
resolveTypeForDocument
:
(
id
:
string
,
specifiedType
?:
string
,
)
=>
Observable
<
string
>
;
}
Index
Properties
initial
Value
listen
Query
pair
resolve
Type
For
Document
Properties
Beta
initial
Value
initialValue
:
(
opts
:
InitialValueOptions
,
context
:
InitialValueResolverContext
,
)
=>
Observable
<
InitialValueMsg
>
Beta
listen
Query
listenQuery
:
(
query
:
string
|
{
fetch
:
string
;
listen
:
string
}
,
params
:
QueryParams
,
options
:
ListenQueryOptions
,
)
=>
Observable
<
any
>
Beta
pair
pair
:
{
consistencyStatus
:
(
publishedId
:
string
,
type
:
string
,
version
?:
string
,
)
=>
Observable
<
boolean
>
;
editState
:
(
publishedId
:
string
,
type
:
string
,
version
?:
string
,
)
=>
Observable
<
EditStateFor
>
;
operationEvents
:
(
publishedId
:
string
,
type
:
string
,
)
=>
Observable
<
OperationSuccess
|
OperationError
>
;
validation
:
(
validationTargetId
:
string
,
type
:
string
,
validatePublishedReferences
:
boolean
,
)
=>
Observable
<
ValidationStatus
>
;
}
Beta
resolve
Type
For
Document
resolveTypeForDocument
:
(
id
:
string
,
specifiedType
?:
string
,
)
=>
Observable
<
string
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
initial
Value
listen
Query
pair
resolve
Type
For
Document
Sanity Library Reference Docs
Loading...
Hidden