From 4d8aa867c7f4661167a4742fbdd865ed2449503e Mon Sep 17 00:00:00 2001
From: Bruce Hill <bruce@bruce-hill.com>
Date: Sun, 30 Nov 2025 14:12:01 -0500
Subject: Add `base` parameter to integer parsing functions

---
 api/api.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'api/api.md')

diff --git a/api/api.md b/api/api.md
index f52691d3..6a7d218b 100644
--- a/api/api.md
+++ b/api/api.md
@@ -662,7 +662,7 @@ assert nums[] == [5, 6, 7, 8, 9, 10]
 ## Int.parse
 
 ```tomo
-Int.parse : func(text: Text, remainder: &Text? = none -> Int?)
+Int.parse : func(text: Text, base: Int? = none, remainder: &Text? = none -> Int?)
 ```
 
 Converts a text representation of an integer into an integer.
@@ -670,6 +670,7 @@ Converts a text representation of an integer into an integer.
 Argument | Type | Description | Default
 ---------|------|-------------|---------
 text | `Text` | The text containing the integer.  | -
+base | `Int?` | The numeric base to use when parsing the integer. If unspecified, the integer's base will be inferred from the text prefix. After any "+" or "-" sign, if the text begins with "0x", the base will be assumed to be 16, "0o" will assume base 8, "0b" will assume base 2, otherwise the base will be assumed to be 10.  | `none`
 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`
 
 **Return:** The integer represented by the text. If the given text contains a value outside of the representable range or if the entire text can't be parsed as an integer, `none` will be returned.
@@ -690,6 +691,9 @@ assert Int.parse("asdf") == none
 # Outside valid range:
 assert Int8.parse("9999999") == none
 
+# Explicitly specifying base:
+assert Int.parse("10", base=16) == 16
+
 ```
 ## Int.prev_prime
 
-- 
cgit v1.2.3