Sanity Library Reference Docs
    Preparing search index...

    Interface ImageRule

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

    Hierarchy (View Summary)

    Index

    Properties

    custom error info required valueOfField warning

    Methods

    assetRequired

    Properties

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

    Methods

    • Require an image field has an asset.

      Returns ImageRule

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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods