DateTimeBuilder class

Builder for DateTime validations with date/time-specific methods.

Usage Examples:

// Future date validation
final futureDateValidator = v().dateTime().inFuture().build();

// Past date validation
final pastDateValidator = v().dateTime().inPast().build();

// Date range validation
final eventDateValidator = v().dateTime()
  .after(DateTime.now())
  .before(DateTime.now().add(Duration(days: 365)))
  .build();

// String to DateTime parsing
final stringDateValidator = v().string().toDateTime().inFuture().build();
Inheritance
Mixed-in types
Available extensions

Constructors

DateTimeBuilder({Chain? chain})

Properties

chain Chain
finalinherited
hashCode int
The hash code for this object.
no setterinherited
isNullable bool
finalinherited
isOptional bool
finalinherited
negated bool
getter/setter pairinherited
not DateTimeBuilder
Return a negated version of the builder (the negation flag is consumed by the next added validator)
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
self DateTimeBuilder
no setterinherited

Methods

add(IValidator validator, {String? message}) DateTimeBuilder
Add a validator to the chain.
inherited
after(DateTime dt, {bool inclusive = false, String? message}) DateTimeBuilder
Validate that the DateTime is after the specified date.
inherited
before(DateTime dt, {bool inclusive = false, String? message}) DateTimeBuilder
Validate that the DateTime is before the specified date.
inherited
betweenDates(DateTime start, DateTime end, {bool inclusiveStart = true, bool inclusiveEnd = true, String? message}) DateTimeBuilder
Validate that the DateTime is within the specified date range. @return The builder for chaining
inherited
build() IValidator
Build resulting validator.
inherited
copyWith({bool? nullable, bool? optional}) IValidator
inherited
deepEq(DateTime value, {String? message}) DateTimeBuilder
Require the value to be deeply equal to the specified value.
inherited
eq(DateTime value, {String? message}) DateTimeBuilder
Require the value to be equal to the specified value.
inherited
error(String message) DateTimeBuilder
Override final error message (retains codes).
inherited
inFuture({bool allowNow = true, String? message}) DateTimeBuilder
Validate that the DateTime is in the future.
inherited
inPast({bool allowNow = true, String? message}) DateTimeBuilder
Validate that the DateTime is in the past.
inherited
isNotValid(dynamic value) bool
inherited
isNotValidAsync(dynamic value) FutureOr<bool>
inherited
isValid(dynamic value) bool
inherited
isValidAsync(dynamic value) FutureOr<bool>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
nullable<_>({String? message}) DateTimeBuilder
Mark current chain nullable (null accepted as valid).
inherited
oneOf(Iterable<DateTime> values, {String? message}) DateTimeBuilder
Require the value to be one of the specified options.
inherited
optional<_>() DateTimeBuilder
Mark current chain optional (skipped when key absent).
inherited
sameDay(DateTime dt, {String? message}) DateTimeBuilder
Validate that the DateTime is on the same day as the specified date.
inherited
toBigInt() NumberBuilder
Transform the value to a BigInt.
inherited
toBool({String? message}) BoolBuilder
Transform the value to a boolean using standard parsing.
inherited
toBoolLenient({String? message}) BoolBuilder
Transform the value to a boolean using lenient parsing.
inherited
toBoolStrict({String? message}) BoolBuilder
Transform the value to a boolean using strict parsing.
inherited
toDateTime() DateTimeBuilder
Transform string to DateTime using standard parsing.
inherited
toDouble({String? message}) DoubleBuilder
Transform the value to a double using standard parsing.
inherited
toInt({String? message}) IntBuilder
Transform the value to an integer using standard parsing.
inherited
toIntSafe({String? message}) IntBuilder
Transform the value to an integer using safe parsing (returns null on failure).
inherited
toIntStrict({String? message}) IntBuilder
Transform the value to an integer using strict parsing (no fallback to 0).
inherited
toJson() JsonDecodedBuilder
Transform JSON string to decoded object (Map/List).
inherited
toNum() NumberBuilder
Transform the value to a number (int or double).
inherited
toString() String
A string representation of this object.
inherited
toString_({String? message}) StringBuilder
Transform the value to a string.
inherited
use(CustomPivot pivot) GenericBuilder
Apply a custom transformation using the provided pivot.
inherited
validate(dynamic value, {bool? exists}) Result
Convenience validate (sync only chain).
inherited
validateAsync(dynamic value, {bool? exists}) Future<Result>
Convenience validateAsync (mixed / async).
inherited
validateOrThrow(dynamic value) Result
inherited
validator(dynamic value) FutureOr<Result>
inherited
wrap(IValidator fn(IValidator), {String? message}) DateTimeBuilder
Wrap the current chain with a custom function.
inherited

Operators

operator &(IValidator other) IValidator

Available on IValidator, provided by the EskemaEskValidatorOperations extension

Combines two validators with a logical AND, same as using all
operator ==(Object other) bool
The equality operator.
inherited
operator >(Expectation error) IValidator

Available on IValidator, provided by the EskemaEskValidatorOperations extension

Returns a new validator that will return the error message if the validation fails
operator |(IValidator other) IValidator

Available on IValidator, provided by the EskemaEskValidatorOperations extension

Combines two validators with a logical OR, same as using any