35 lines
777 B
Markdown
35 lines
777 B
Markdown
# 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.
|
|
|
|
- [`func parse(text: Text -> Bool?)`](#parse)
|
|
|
|
### `parse`
|
|
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`.
|
|
|
|
```tomo
|
|
func parse(text: Text -> Bool?)
|
|
```
|
|
|
|
- `text`: The string containing the boolean value.
|
|
|
|
**Returns:**
|
|
`yes` if the string matches a recognized truthy boolean value; otherwise return `no`.
|
|
|
|
**Example:**
|
|
```tomo
|
|
>> Bool.parse("yes")
|
|
= yes : Bool?
|
|
>> Bool.parse("no")
|
|
= no : Bool?
|
|
>> Bool.parse("???")
|
|
= none : Bool?
|
|
```
|