Sanity Library Reference Docs
    Preparing search index...

    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)

    Index

    Properties

    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