Sanity Library Reference Docs
Preparing search index...
sanity
index
DocumentRule
Interface DocumentRule
interface
DocumentRule
{
custom
:
<
LenientFieldValue
extends
SanityDocument
>
(
fn
:
CustomValidator
<
LenientFieldValue
>
,
)
=>
DocumentRule
;
error
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
DocumentRule
;
info
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
DocumentRule
;
required
:
()
=>
DocumentRule
;
valueOfField
:
(
path
:
string
|
string
[]
)
=>
FieldReference
;
warning
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
DocumentRule
;
}
Hierarchy (
View Summary
)
RuleDef
<
DocumentRule
,
SanityDocument
>
DocumentRule
Index
Properties
custom
error
info
required
value
Of
Field
warning
Properties
custom
custom
:
<
LenientFieldValue
extends
SanityDocument
>
(
fn
:
CustomValidator
<
LenientFieldValue
>
,
)
=>
DocumentRule
error
error
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
DocumentRule
info
info
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
DocumentRule
required
required
:
()
=>
DocumentRule
value
Of
Field
valueOfField
:
(
path
:
string
|
string
[]
)
=>
FieldReference
warning
warning
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
DocumentRule
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
custom
error
info
required
value
Of
Field
warning
Sanity Library Reference Docs
Loading...