tomo/docs/booleans.md

38 lines
781 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").
# Boolean Functions
This documentation provides details on boolean functions available in the API.
## `from_text`
**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
func from_text(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-08-18 16:34:07 -07:00
>> Bool.from_text("yes")
= yes?
2024-08-18 16:34:07 -07:00
>> Bool.from_text("no")
= no?
>> Bool.from_text("???")
= !Bool
2024-08-18 13:51:25 -07:00
```