tomo/docs/booleans.md

38 lines
784 B
Markdown
Raw Normal View History

2024-08-18 13:51:25 -07:00
# Boolean Values
Boolean values have the type `Bool` and can be either `yes` ("true") or `no`
("false").
2025-03-04 21:11:18 -08:00
## Boolean Functions
2024-08-18 13:51:25 -07:00
This documentation provides details on boolean functions available in the API.
2025-03-04 21:11:18 -08:00
### `parse`
2024-08-18 13:51:25 -07:00
**Description:**
Converts a string representation of a boolean value into a boolean. Acceptable
boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`,
`true`/`false`, `on`/`off`.
**Signature:**
2024-08-18 13:51:25 -07:00
```tomo
2024-11-09 12:11:11 -08:00
func parse(text: Text -> Bool?)
2024-08-18 13:51:25 -07:00
```
**Parameters:**
- `text`: The string containing the boolean value.
**Returns:**
`yes` if the string matches a recognized truthy boolean value; otherwise return `no`.
**Example:**
```tomo
2024-11-09 12:11:11 -08:00
>> Bool.parse("yes")
= yes : Bool?
2024-11-09 12:11:11 -08:00
>> Bool.parse("no")
= no : Bool?
2024-11-09 12:11:11 -08:00
>> Bool.parse("???")
2024-12-07 13:04:25 -08:00
= none : Bool?
2024-08-18 13:51:25 -07:00
```