Add README for API

This commit is contained in:
Bruce Hill 2024-08-18 18:30:40 -04:00
parent 43b4af23f8
commit 46e0d88e88

66
api/README.md Normal file
View File

@ -0,0 +1,66 @@
# API
Tomo has a small number of built-in functions and bunch of types.
## Types
- [Arrays](arrays.md)
- [Booleans](booleans.md)
- [Channels](channels.md)
- [Integers](integers.md)
- [Floating point numbers](nums.md)
- [Integer Ranges](ranges.md)
- [Sets](sets.md)
- [Tables](tables.md)
- [Text](text.md)
- [Threads](threads.md)
## Built-in Functions
### `say`
**Description:**
Prints a message to the console.
**Usage:**
```markdown
say(text:Text) -> Void
```
**Parameters:**
- `text`: The text to print.
**Returns:**
Nothing.
**Example:**
```markdown
say("Hello world!")
```
---
### `fail`
**Description:**
Prints a message to the console, aborts the program, and prints a stack trace.
**Usage:**
```markdown
fail(message:Text) -> Abort
```
**Parameters:**
- `message`: The error message to print.
**Returns:**
Nothing, aborts the program.
**Example:**
```markdown
fail("Oh no!")
```
---