Interface VideoRule

interface VideoRule {
    custom: <LenientFieldValue extends VideoValue>(
        fn: CustomValidator<LenientFieldValue>,
    ) => VideoRule;
    error: (message?: string | LocalizedValidationMessages) => VideoRule;
    info: (message?: string | LocalizedValidationMessages) => VideoRule;
    required: () => VideoRule;
    skip: () => VideoRule;
    valueOfField: (path: string | string[]) => FieldReference;
    warning: (message?: string | LocalizedValidationMessages) => VideoRule;
    assetRequired(): VideoRule;
}

Hierarchy (View Summary)

RuleDef<VideoRule, VideoValue>
- VideoRule

Index

Properties

custom error info required skip valueOfField warning

Methods

Properties

custom

custom: <LenientFieldValue extends VideoValue>(
fn: CustomValidator<LenientFieldValue>,
) => VideoRule

error

error: (message?: string | LocalizedValidationMessages) => VideoRule

info

info: (message?: string | LocalizedValidationMessages) => VideoRule

required

required: () => VideoRule

skip

skip: () => VideoRule

valueOfField

valueOfField: (path: string | string[]) => FieldReference

warning

warning: (message?: string | LocalizedValidationMessages) => VideoRule

Methods

assetRequired

assetRequired(): VideoRule
Require a file field has an asset.

Returns VideoRule
Example
```
defineField({
 name: 'video',
 title: 'Video',
 type: 'sanity.video',
 validation: (Rule) => Rule.required().assetRequired(),
})
```
- Defined in packages/sanity/src/media-library/plugin/schemas/types.ts:41