Improved parsing and prefix/suffix matching using a `remainder`

parameter

1 files changed, 14 insertions, 1 deletions

diff --git a/api/booleans.yaml b/api/booleans.yaml
index 0831ac18..1d9d68fd 100644
--- a/api/booleans.yaml
+++ b/api/booleans.yaml
@@ -13,6 +13,12 @@ Bool.parse:
       type: 'Text'
       description: >
         The string containing the boolean value.
+    remainder:
+      type: '&Text?'
+      default: 'none'
+      description: >
+        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.
   example: |
     >> Bool.parse("yes")
     = yes : Bool?
@@ -20,4 +26,11 @@ Bool.parse:
     = no : Bool?
     >> Bool.parse("???")
     = none : Bool?
-    
+
+    >> Bool.parse("yesJUNK")
+    = none : Bool?
+    remainder : Text
+    >> Bool.parse("yesJUNK", &remainder)
+    = yes : Bool?
+    >> remainder
+    = "JUNK"