ZString Schema Documentation
The ZString class is a schema used for validating string values in the zard package. It extends the Schema<String> base class and provides a variety of validation methods for strings.
Constructor ZString({String? message})
Initializes a new instance of ZString with an optional custom error message if the value is not a valid string.
Example:
final value = z.string.parse("Hello"); // returns "Hello"Methods
min
min(int length, {String? message});
Validates that the string has at least the specified minimum number of characters.
Example:
final minSchema = z.string().min(3);
final name = minSchema.parse("John"); // returns "John"
final name = minSchema.parse("Jo"); // returns ZardErrormax
max(int length, {String? message});
Validates that the string has no more than the specified maximum number of characters.
Example:
final maxSchema = z.string().max(10);
final name = maxSchema.parse("short"); // returns "short"
final name = maxSchema.parse("this string is too long"); // returns ZardErrorlength
length(int length, {String? message});
Validates that the string has exactly the specified length.
Example:
final lengthSchema = z.string().length(5);
final value = lengthSchema.parse('Hello'); // returns "Hello"
final value = lengthSchema.parse('Hi'); // returns ZardErroremail
email({String? message});
Validates that the string is in a valid email format.
Example:
final emailSchema = z.string().email();
final email = emailSchema.parse("john@example.com"); // returns "john@example.com"
final email = emailSchema.parse("john@example"); // returns ZardErrorurl
url({String? message});
Validates that the string is a valid URL.
Example:
final urlSchema = z.string().url();
final url = urlSchema.parse("https://example.com"); // returns the URL
final url = urlSchema.parse("invalid-url"); // return ZardErrorstartsWith
startsWith(String prefix, {String? message});
Validates that the string starts with the specified prefix.
Example:
final startsWithSchema = z.string().startsWith("Hello");
final result = startsWithSchema.parse("Hello world"); // returns "Hello world"
final result = startsWithSchema.parse("world Hello"); // returns ZardErrorendsWith
ndsWith(String suffix, {String? message});
Validates that the string ends with the specified suffix.
Example:
final endsWithSchema = z.string().endsWith("world");
final result = endsWithSchema.parse("Hello world"); // returns "Hello world"
final result = endsWithSchema.parse("world Hello"); // returns ZardErrorregex
regex(RegExp pattern, {String? message});
Validates that the string matches a specific regular expression.
Example:
final regexSchema = z.string().regex(RegExp(r'^\d{3}-\d{2}-\d{4}\$'));
final result = regexSchema.parse("123-45-6789"); // returns the string
final result = regexSchema.parse("abc"); // returns ZardErrordate
date({String? message});
Validates that the string is in the format YYYY-MM-DD.
Example:
final dateSchema = z.string().date();
final value = dateSchema.parse('2024-04-19'); // returns 2024-04-19
final value = dateSchema.parse('2021-01-01T12:30:00'); // returns ZardErrordatetime
datetime({String? message});
Validates that the string is a valid ISO 8601 datetime format.
Example:
final datetimeSchema = z.string().datetime();
final value = datetimeSchema.parse('2025-04-19T15:30:00'); // returns 2025-04-19T15:30:00
final value = datetimeSchema.parse('19/04/2025 15:30'); // returns ZardErrortime
time({String? message});
Validates that the string is a valid time format (HH:mm:ss).
Example:
final timeSchema = z.string().time();
final value = timeSchema.parse('12:00:00'); // returns 2025-04-19T15:30:00
final value = timeSchema.parse('12:00'); // returns ZardErroruuid
uuid({String? message});
Validates that the string is a valid UUID (version 4).
Example:
final uuidSchema = z.string().uuid();
final value = uuidSchema.parse('550e8400-e29b-41d4-a716-446655440000');
// returns 550e8400-e29b-41d4-a716-446655440000
final value = uuidSchema.parse('invalid-uuid'); // returns ZardErrorcuid
cuid({String? message});
Validates that the string is a valid CUID (Compact Unique IDentifier).
Example:
final cuidSchema = z.string().cuid();
final cuid = cuidSchema.parse('abcdefghijklmnopqrst'); // returns abcdefghijklmnopqrst
final cuid = cuidSchema.parse('short'); // returns ZardErrorcuid2
cuid2({String? message});
Validates that the string is a valid CUID2 (Compact Unique IDentifier version 2).
Example:
final cuidSchema = z.string().cuid2();
final cuid2 = cuidSchema.parse('abcdefghijklmnopqrstuvwxxy');
// returns abcdefghijklmnopqrst
final cuid2 = cuidSchema.parse('short'); // returns ZardErrorcontains
contains(String substring, {String? message});
Validates that the string contains the specified substring.
Example:
final containsSchema = z.string().contains('test');
final value = containsSchema.parse('this is a test'); // returns "this is a test"
final value = containsSchema.parse('no match here'); // returns ZardErrorFull Example Usage
final emailSchema = z.string().min(3).max(100).email().endsWith('@example.com');
final email = emailSchema.parse("john@example.com");