Files
modeling-app/docs/kcl/assertLessThanOrEq.md
Nick Cameron 1104d908c0 Improve hover tool tips and function docs (#5538)
* Improve hover tool tips and function docs

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores)

* A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores)

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-02-27 22:03:37 +13:00

26 KiB

title, excerpt, layout
title excerpt layout
assertLessThanOrEq Check that a numerical value is less than or equal to another at runtime, manual

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

Name Type Description Required
left number Yes
right number Yes
message string Yes

Returns

()

Examples

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

Rendered example of assertLessThanOrEq 0