Skip to content

class Athena::Validator::Constraints::PositiveOrZero
inherits Athena::Validator::Constraints::GreaterThanOrEqual #

Validates that a value is a positive number, or 0. Use AVD::Constraints::Positive if you don't want to allow 0.


Optional Arguments#


Type: String Default: This value should be positive or zero.

The message that will be shown if the value is not greater than or equal to 0.


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.

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

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


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.

Class methods#

.new(message : String = "This value should be positive or zero.", groups : Array(String) | String | Nil = nil, payload : Hash(String, String)? = nil) #

View source


#validated_by : AVD::ConstraintValidator.class #


View source