blob: 338a26e9c04764173739ccfd576ee2a05574f924 (
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
|
% API
# Builtins
# Bool
## Bool.parse
```tomo
Bool.parse : func(text: Text -> Bool?)
```
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`.
Argument | Type | Description | Default
---------|------|-------------|---------
text | `Text` | The string containing the boolean value. | -
**Return:** `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?
```
|
