* 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>
41 lines
26 KiB
Markdown
41 lines
26 KiB
Markdown
---
|
|
title: "assert"
|
|
excerpt: "Check a value at runtime, and raise an error if the argument provided"
|
|
layout: manual
|
|
---
|
|
|
|
Check a value at runtime, and raise an error if the argument provided
|
|
|
|
is false.
|
|
|
|
```js
|
|
assert(
|
|
data: bool,
|
|
message: string,
|
|
) -> ()
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `data` | `bool` | | Yes |
|
|
| `message` | `string` | | Yes |
|
|
|
|
### Returns
|
|
|
|
`()`
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
myVar = true
|
|
assert(myVar, "should always be true")
|
|
```
|
|
|
|

|
|
|
|
|