Files
modeling-app/docs/kcl-std/assertIs.md
Nick Cameron 574d6dae7f Add modules to docs (#6699)
* Support modules in docs

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

* shuffle around directories

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-06 11:02:55 +12:00

26 KiB

title, excerpt, layout
title excerpt layout
assertIs Asserts that a value is the boolean value true. manual

Asserts that a value is the boolean value true.

assertIs(
  actual: bool,
  error?: string,
): ()

Arguments

Name Type Description Required
actual bool Value to check. If this is the boolean value true, assert passes. Otherwise it fails. Yes
error string If the value was false, the program will terminate with this error message No

Returns

()

Examples

kclIsFun = true
assertIs(kclIsFun)

Rendered example of assertIs 0