diff options
Diffstat (limited to 'api/booleans.md')
| -rw-r--r-- | api/booleans.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/api/booleans.md b/api/booleans.md new file mode 100644 index 00000000..e6a01066 --- /dev/null +++ b/api/booleans.md @@ -0,0 +1,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? + +``` |
