constraints.checkMaximum {tableschema.r}

Check if maximum constraint is met

Description

Specifies a maximum value for a field. This is different to maxLength which checks the number of items in the value. A maximum value constraint checks whether a field value is equal to or less than the specified value. The range checking depends on the type of the field. E.g. an integer field may have a maximum value of 100. If a maximum value constraint is specified then the field descriptor MUST contain a type key.

Usage

constraints.checkMaximum(constraint, value)

Arguments

constraint

numeric constraint value

value

numeric value to meet the constraint

Value

TRUE if value is equal to or less than the constraint

See Also

Constraints specifications

Examples

constraints.checkMaximum(constraint = list(2), value = 1)

constraints.checkMaximum(constraint = 2, value = 3)