aboutsummaryrefslogtreecommitdiff
path: root/api/lists.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-04-21 14:54:23 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-04-21 14:54:23 -0400
commitaa5578ffe8fb2a9e6d24b0077f5d7ced630b7dfa (patch)
tree2749ac2aa1a2f91bbb0b4e72bc17b29f204e57cc /api/lists.md
parent6ee5af0a16a5f1a32eb933e30d8b86ff4e691beb (diff)
Rename List.first() to List.where()
Diffstat (limited to 'api/lists.md')
-rw-r--r--api/lists.md48
1 files changed, 24 insertions, 24 deletions
diff --git a/api/lists.md b/api/lists.md
index 727aa077..32433bee 100644
--- a/api/lists.md
+++ b/api/lists.md
@@ -119,30 +119,6 @@ target | `T` | The item to search for. | -
= none : Int?
```
-## List.first
-
-```tomo
-List.first : func(list: [T], predicate: func(item:&T -> Bool) -> Int)
-```
-
-Find the index of the first item that matches a predicate function (if any).
-
-Argument | Type | Description | Default
----------|------|-------------|---------
-list | `[T]` | The list to search through. | -
-predicate | `func(item:&T -> Bool)` | A function that returns `yes` if the item should be returned or `no` if it should not. | -
-
-**Return:** Returns the index of the first item where the predicate is true or `!Int` if no item matches.
-
-
-**Example:**
-```tomo
->> [4, 5, 6].find(func(i:&Int): i.is_prime())
-= 5 : Int?
->> [4, 6, 8].find(func(i:&Int): i.is_prime())
-= none : Int?
-
-```
## List.from
```tomo
@@ -649,3 +625,27 @@ list | `[T]` | The list to process. | -
= {10, 20, 30}
```
+## List.where
+
+```tomo
+List.where : func(list: [T], predicate: func(item:&T -> Bool) -> Int)
+```
+
+Find the index of the first item that matches a predicate function (if any).
+
+Argument | Type | Description | Default
+---------|------|-------------|---------
+list | `[T]` | The list to search through. | -
+predicate | `func(item:&T -> Bool)` | A function that returns `yes` if the item's index should be returned or `no` if it should not. | -
+
+**Return:** Returns the index of the first item where the predicate is true or `!Int` if no item matches.
+
+
+**Example:**
+```tomo
+>> [4, 5, 6].where(func(i:&Int): i.is_prime())
+= 5 : Int?
+>> [4, 6, 8].find(func(i:&Int): i.is_prime())
+= none : Int?
+
+```