Files
modeling-app/docs/kcl/assertEqual.md
Adam Chalmers 84865eaed0 Add assertEqual function to KCL stdlib (#3279)
Takes a tolerance, because floating-point imprecision.
2024-08-05 16:31:58 +00:00

94 KiB

title, excerpt, layout
title excerpt layout
assertEqual Check that a numerical value equals another at runtime, manual

Check that a numerical value equals another at runtime,

otherwise raise an error.

assertEqual(left: number, right: number, epsilon: number, message: string) -> ()

Examples

let n = 1.0285
let m = 1.0286
assertEqual(n, m, 0.01, "n is within the given tolerance for m")

Rendered example of assertEqual 0

Arguments

  • left: number (REQUIRED)
  • right: number (REQUIRED)
  • epsilon: number (REQUIRED)
  • message: string (REQUIRED)

Returns

()