Sanity App SDK
Preparing search index...
@sanity/sdk
index
getDocumentState
Function getDocumentState
getDocumentState
<
TDocumentType
extends
string
=
string
,
TDataset
extends
string
=
string
,
TProjectId
extends
string
=
string
,
>
(
instance
:
SanityInstance
,
options
:
DocumentOptions
<
undefined
,
TDocumentType
,
TDataset
,
TProjectId
>
,
)
:
StateSource
<
|
undefined
|
null
|
SanityDocument
<
TDocumentType
,
`
${
TProjectId
}
.
${
TDataset
}
`
>
,
>
Beta
Type Parameters
TDocumentType
extends
string
=
string
TDataset
extends
string
=
string
TProjectId
extends
string
=
string
Parameters
instance
:
SanityInstance
options
:
DocumentOptions
<
undefined
,
TDocumentType
,
TDataset
,
TProjectId
>
Returns
StateSource
<
|
undefined
|
null
|
SanityDocument
<
TDocumentType
,
`
${
TProjectId
}
.
${
TDataset
}
`
>
,
>
getDocumentState
<
TPath
extends
string
=
string
,
TDocumentType
extends
string
=
string
,
TDataset
extends
string
=
string
,
TProjectId
extends
string
=
string
,
>
(
instance
:
SanityInstance
,
options
:
DocumentOptions
<
TPath
,
TDocumentType
,
TDataset
,
TProjectId
>
,
)
:
StateSource
<
|
undefined
|
JsonMatch
<
SanityDocument
<
TDocumentType
,
`
${
TProjectId
}
.
${
TDataset
}
`
>
,
TPath
,
>
,
>
Beta
Type Parameters
TPath
extends
string
=
string
TDocumentType
extends
string
=
string
TDataset
extends
string
=
string
TProjectId
extends
string
=
string
Parameters
instance
:
SanityInstance
options
:
DocumentOptions
<
TPath
,
TDocumentType
,
TDataset
,
TProjectId
>
Returns
StateSource
<
|
undefined
|
JsonMatch
<
SanityDocument
<
TDocumentType
,
`
${
TProjectId
}
.
${
TDataset
}
`
>
,
TPath
,
>
,
>
getDocumentState
<
TData
>
(
instance
:
SanityInstance
,
options
:
DocumentOptions
<
undefined
|
string
>
,
)
:
StateSource
<
undefined
|
null
|
TData
>
Beta
Type Parameters
TData
Parameters
instance
:
SanityInstance
options
:
DocumentOptions
<
undefined
|
string
>
Returns
StateSource
<
undefined
|
null
|
TData
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Sanity App SDK
Loading...