RGex Builder Platform - v1.2.0
    Preparing search index...

    Variable humanToValidationConst

    humanToValidation: (
        humanText: string,
        testValue?: string,
    ) => ValidationExtractionResult = parseHumanTextToValidation

    Extracts validation rules from human-readable requirement descriptions. This alias for parseHumanTextToValidation converts natural language validation requirements into structured validation rule objects with patterns and functions.

    Type declaration

      • (humanText: string, testValue?: string): ValidationExtractionResult
      • Parses a human-readable string to extract a set of validation rules. It identifies keywords for common validation requirements (e.g., "required", "strong password") and also leverages parseHumanTextToRegex to create pattern-based rules.

        Parameters

        • humanText: string

          The natural language string describing the validation requirements.

        • OptionaltestValue: string

          An optional string to test the extracted rules against.

        Returns ValidationExtractionResult

        A ValidationExtractionResult object containing the rules, confidence, and other metadata.

    Natural language describing validation requirements. Examples: "required email", "strong password with special characters", "optional phone number", "text between 10 and 100 characters"

    Optional input to validate against the extracted rules. Helps determine rule accuracy and provides immediate feedback on compliance.

    Comprehensive ValidationExtractionResult containing:

    • success: Boolean indicating successful rule extraction
    • rules: Array of ValidationRule objects with patterns, validators, and messages
    • confidence: Overall confidence in the extracted validation logic
    • description: Summary of extracted validation requirements
    • suggestions: Helpful tips for improving validation or fixing issues
    • allPassed: Boolean indicating if test value passes all rules (when provided)
    • caseUnPassed: Array of rule names that failed validation (when test provided)
    // Basic required field
    const emailValidation = humanToValidation("required email address");
    // Returns rules for: required field + email format

    // Complex password requirements
    const passwordRules = humanToValidation("strong password minimum 8 characters");

    // With immediate testing
    const result = humanToValidation("required phone number", "555-1234");
    console.log(result.allPassed); // true/false
    console.log(result.caseUnPassed); // ["required", "phoneFormat"] if failed