Sanity Library Reference Docs
    Preparing search index...

    Interface StringRule

    interface StringRule {
        custom: <LenientFieldValue extends string>(
            fn: CustomValidator<LenientFieldValue>,
        ) => StringRule;
        error: (message?: string | LocalizedValidationMessages) => StringRule;
        info: (message?: string | LocalizedValidationMessages) => StringRule;
        length: (exactLength: number | FieldReference) => StringRule;
        lowercase: () => StringRule;
        max: (maxNumber: number | FieldReference) => StringRule;
        min: (minNumber: number | FieldReference) => StringRule;
        required: () => StringRule;
        uppercase: () => StringRule;
        valueOfField: (path: string | string[]) => FieldReference;
        warning: (message?: string | LocalizedValidationMessages) => StringRule;
        email(): StringRule;
        regex(
            pattern: RegExp,
            name: string,
            options: { invert?: boolean; name?: string },
        ): StringRule;
        regex(
            pattern: RegExp,
            options: { invert?: boolean; name?: string },
        ): StringRule;
        regex(pattern: RegExp, name: string): StringRule;
        regex(pattern: RegExp): StringRule;
    }

    Hierarchy (View Summary)

    Index

    Properties

    custom error info length lowercase max min required uppercase valueOfField warning

    Methods

    email regex

    Properties

    custom: <LenientFieldValue extends string>(
        fn: CustomValidator<LenientFieldValue>,
    ) => StringRule
    error: (message?: string | LocalizedValidationMessages) => StringRule
    info: (message?: string | LocalizedValidationMessages) => StringRule
    length: (exactLength: number | FieldReference) => StringRule
    lowercase: () => StringRule
    max: (maxNumber: number | FieldReference) => StringRule
    min: (minNumber: number | FieldReference) => StringRule
    required: () => StringRule
    uppercase: () => StringRule
    valueOfField: (path: string | string[]) => FieldReference
    warning: (message?: string | LocalizedValidationMessages) => StringRule

    Methods

    • Parameters

      • pattern: RegExp
      • name: string
      • options: { invert?: boolean; name?: string }

      Returns StringRule

    • Parameters

      • pattern: RegExp
      • options: { invert?: boolean; name?: string }

      Returns StringRule

    • Parameters

      • pattern: RegExp
      • name: string

      Returns StringRule

    • Parameters

      • pattern: RegExp

      Returns StringRule

    Settings

    Member Visibility

    On This Page

    Properties
    Methods