1 % API
   2 
   3 # Builtins
   4 
   5 # Bool
   6 ## Bool.parse
   7 
   8 ```tomo
   9 Bool.parse : func(text: Text, remainder: &Text? = none -> Bool?)
  10 ```
  11 
  12 Converts a text representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.
  13 
  14 Argument | Type | Description | Default
  15 ---------|------|-------------|---------
  16 text | `Text` | The string containing the boolean value.  | -
  17 remainder | `&Text?` | If non-none, this argument will be set to the remainder of the text after the matching part. If none, parsing will only succeed if the entire text matches.  | `none`
  18 
  19 **Return:** `yes` if the string matches a recognized truthy boolean value; otherwise return `no`.
  20 
  21 
  22 **Example:**
  23 ```tomo
  24 assert Bool.parse("yes") == yes
  25 assert Bool.parse("no") == no
  26 assert Bool.parse("???") == none
  27 
  28 assert Bool.parse("yesJUNK") == none
  29 remainder : Text
  30 assert Bool.parse("yesJUNK", &remainder) == yes
  31 assert remainder == "JUNK"
  32 
  33 ```