Sanity Library Reference Docs
Preparing search index...
sanity
index
RuleDef
Interface RuleDef<T, FieldValue>
interface
RuleDef
<
T
,
FieldValue
=
unknown
>
{
custom
:
<
LenientFieldValue
>
(
fn
:
CustomValidator
<
LenientFieldValue
>
)
=>
T
;
error
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
T
;
info
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
T
;
required
:
()
=>
T
;
valueOfField
:
(
path
:
string
|
string
[]
)
=>
FieldReference
;
warning
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
T
;
}
Type Parameters
T
FieldValue
=
unknown
Hierarchy (
View Summary
)
RuleDef
ArrayRule
BlockRule
BooleanRule
DateRule
DatetimeRule
DocumentRule
EmailRule
FileRule
GeopointRule
ImageRule
NumberRule
ObjectRule
ReferenceRule
SlugRule
StringRule
UrlRule
Index
Properties
custom
error
info
required
value
Of
Field
warning
Properties
custom
custom
:
<
LenientFieldValue
>
(
fn
:
CustomValidator
<
LenientFieldValue
>
)
=>
T
error
error
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
T
info
info
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
T
required
required
:
()
=>
T
value
Of
Field
valueOfField
:
(
path
:
string
|
string
[]
)
=>
FieldReference
warning
warning
:
(
message
?:
string
|
LocalizedValidationMessages
)
=>
T
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...