blob: d2a22d5ca47bd7468c76cdba8be64a8b213a9635 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
# 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.
## `parse`
**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:**
```tomo
func parse(text: Text -> Bool?)
```
**Parameters:**
- `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?
```
|
