Sanity Library Reference Docs
    Preparing search index...

    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)

    Index

    Properties

    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