* 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>
42 lines
26 KiB
Markdown
42 lines
26 KiB
Markdown
---
|
|
title: "assertLessThan"
|
|
excerpt: "Check that a numerical value is less than to another at runtime,"
|
|
layout: manual
|
|
---
|
|
|
|
Check that a numerical value is less than to another at runtime,
|
|
|
|
otherwise raise an error.
|
|
|
|
```js
|
|
assertLessThan(
|
|
left: number,
|
|
right: number,
|
|
message: string,
|
|
) -> ()
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `left` | `number` | | Yes |
|
|
| `right` | `number` | | Yes |
|
|
| `message` | `string` | | Yes |
|
|
|
|
### Returns
|
|
|
|
`()`
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
assertLessThan(1, 2, "1 is less than 2")
|
|
```
|
|
|
|

|
|
|
|
|