modeling-app/docs/kcl-std/assertIs.md

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)