c050739f41
* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
26 KiB
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](/docs/kcl/types/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)