Skip to content

GreaterThan

class Athena::Validator::Constraints::GreaterThan(ValueType)
inherits Athena::Validator::Constraint

Validates that a value is greater than another.

Configuration

Required Arguments
value

Type: Number | String | Time

Defines the value that the value being validated should be compared to.

Optional Arguments
message

Type: String Default: This value should be greater than {{ compared_value }}.

The message that will be shown if the value is not greater than the comparison value.

Placeholders

The following placeholders can be used in this message:

  • {{ value }} - The current (invalid) value.
  • {{ compared_value }} - The expected value.
  • {{ compared_value_type }} - The type of the expected value.
groups

Type: Array(String) | String | Nil Default: nil

The validation groups this constraint belongs to. AVD::Constraint::DEFAULT_GROUP is assumed if nil.

payload

Type: Hash(String, String)? Default: nil

Any arbitrary domain-specific data that should be stored with this constraint. The payload is not used by Athena::Validator, but its processing is completely up to you.

Included modules

Athena::Validator::Constraints::AbstractComparison

Direct known subclasses

Athena::Validator::Constraints::Positive

Constants

TOO_LOW_ERROR = "a221096d-d125-44e8-a865-4270379ac11a"

Class methods

.new(value : ValueType, message : String = default_error_message, groups : Array(String) | String | Nil = nil, payload : Hash(String, String)? = nil)

Methods

#default_error_message : String

Returns the AVD::Constraint#message for this constraint.

#validated_by : AVD::ConstraintValidator.class

Returns the AVD::ConstraintValidator.class that should handle validating self.