MapMixin<B extends BaseBuilder<B, T>, T> mixin

Mixin providing map-specific validation methods.

Superclass constraints
Mixin applications
Available extensions

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 → B
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 → B
no setterinherited

Methods

add(IValidator validator, {String? message}) → B
Add a validator to the chain.
inherited
build() → IValidator
Build resulting validator.
inherited
containsKey(dynamic key, {String? message}) → B
Validate that the map contains the specified key.
copyWith({bool? nullable, bool? optional}) → IValidator
inherited
deepEq(T value, {String? message}) → B
Require the value to be deeply equal to the specified value.
inherited
eq(T value, {String? message}) → B
Require the value to be equal to the specified value.
inherited
error(String message) → B
Override final error message (retains codes).
inherited
flattenKeys([String delimiter = '.']) → B
Flatten nested map keys using the specified delimiter.
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}) → B
Mark current chain nullable (null accepted as valid).
inherited
oneOf(Iterable<T> values, {String? message}) → B
Require the value to be one of the specified options.
inherited
optional<_>() → B
Mark current chain optional (skipped when key absent).
inherited
pick(Iterable<String> keys) → B
Extract only the specified keys from the map.
pluck(String key) → B
Extract a single key from the map, keeping the map structure. @return The builder for chaining
pluckValue(String key) → GenericBuilder
Extract a single value from the map, returning a GenericBuilder for further operations. @return A GenericBuilder for the extracted value
schema(Map<String, IValidator> schema) → B
Validate the map against a schema where keys are optional unless specified.
strict(Map<String, IValidator> schema) → B
Validate the map against a strict schema where all keys must be present and match the validators.
toString() → String
A string representation of this object.
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}) → B
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