diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2024-08-18 16:51:25 -0400 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2024-08-18 16:51:25 -0400 |
| commit | a86eba55d7e26bc357735ccf190013b9346ccb4d (patch) | |
| tree | 6be768661c0794e8319b76654a0a5ca8fb82fa42 /api/booleans.md | |
| parent | 1e4f41bc28d781819a1a9d18d53abc0bbb8f5f21 (diff) | |
Add API docs
Diffstat (limited to 'api/booleans.md')
| -rw-r--r-- | api/booleans.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/api/booleans.md b/api/booleans.md new file mode 100644 index 00000000..86473b42 --- /dev/null +++ b/api/booleans.md @@ -0,0 +1,60 @@ +# 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`. + +**Usage:** +```tomo +from_text(text: Text, success: Bool = !&Bool) -> Bool +``` + +**Parameters:** + +- `text`: The string containing the boolean value. +- `success`: If provided, this boolean value reference will be set to `yes` if the given text is a recognizable boolean value or `no` otherwise. + +**Returns:** +`yes` if the string matches a recognized truthy boolean value; otherwise return `no`. + +**Example:** +```tomo +Boo.from_text("yes") // yes +from_text("no") // no +from_text("maybe") // !&Bool (default value) +``` + +--- + +## `random` + +**Description:** +Generates a random boolean value based on a specified probability. + +**Usage:** +```tomo +random(p: Float = 0.5) -> Bool +``` + +**Parameters:** + +- `p`: The probability (between `0` and `1`) of returning `yes`. Default is `0.5`. + +**Returns:** +`yes` with probability `p`, and `no` with probability `1 - p`. + +**Example:** +```tomo +random(0.7) // yes (with 70% probability) +random(0.3) // no (with 70% probability) +``` |
