kcl

assertLessThanOrEq

Check that a numerical value is less than or equal to another at runtime, otherwise raise an error.

assertLessThanOrEq(
  left: number,
  right: number,
  message: string,
): ()

Arguments

NameTypeDescriptionRequired
leftnumberYes
rightnumberYes
messagestringYes

Returns

()

Examples

assertLessThanOrEq(1, 2, "1 is less than 2")
assertLessThanOrEq(1, 1, "1 is equal to 1")

Rendered example of assertLessThanOrEq 0