kcl

assertGreaterThanOrEq

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

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

Arguments

NameTypeDescriptionRequired
leftnumberYes
rightnumberYes
messagestringYes

Returns

()

Examples

assertGreaterThanOrEq(2, 1, "2 is greater than 1")
assertGreaterThanOrEq(1, 1, "1 is equal to 1")

Rendered example of assertGreaterThanOrEq 0