Sanity Library Reference Docs
    Preparing search index...

    Interface FileRule

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

    Hierarchy (View Summary)

    Index

    Properties

    custom error info required valueOfField warning

    Methods

    assetRequired

    Properties

    custom: <LenientFieldValue extends FileValue>(
        fn: CustomValidator<LenientFieldValue>,
    ) => FileRule
    error: (message?: string | LocalizedValidationMessages) => FileRule
    info: (message?: string | LocalizedValidationMessages) => FileRule
    required: () => FileRule
    valueOfField: (path: string | string[]) => FieldReference
    warning: (message?: string | LocalizedValidationMessages) => FileRule

    Methods

    • Require a file field has an asset.

      Returns FileRule

      defineField({
       name: 'file',
       title: 'File',
       type: 'file',
       validation: (Rule) => Rule.required().assetRequired(),
      })

    Settings

    Member Visibility

    On This Page

    Properties
    Methods