WayrApp Backend & Ecosystem Documentation - v1.0.0
    Preparing search index...

    Function TextFieldSchema

    • Generic text field validation schema factory function

      Factory function that creates customizable text field validation schemas with configurable minimum and maximum length constraints. This function provides a reusable pattern for creating consistent text validation across the application while allowing flexibility for different field requirements.

      The factory approach enables creation of text schemas with appropriate length limits for different use cases, from short titles and names to longer descriptions and content. Default values provide sensible constraints for most common text fields while allowing customization for specific needs.

      Parameters

      • minLength: number = 1

        Minimum required length (default: 1)

      • maxLength: number = 255

        Maximum allowed length (default: 255)

      Returns ZodString

      Configured text validation schema

      // Different text field configurations
      const TitleSchema = TextFieldSchema(1, 100); // Required title, max 100 chars
      const DescriptionSchema = TextFieldSchema(10, 500); // Required description, 10-500 chars
      const TagSchema = TextFieldSchema(1, 50); // Short tags, max 50 chars
      // Content creation schema with varied text fields
      const CourseSchema = z.object({
      title: TextFieldSchema(1, 200),
      subtitle: TextFieldSchema(1, 300),
      description: TextFieldSchema(50, 2000),
      tags: z.array(TextFieldSchema(1, 30)).max(10)
      });
      // User profile with different text requirements
      const ProfileSchema = z.object({
      displayName: TextFieldSchema(2, 50),
      bio: TextFieldSchema(10, 500),
      location: TextFieldSchema(2, 100)
      });