aboutsummaryrefslogtreecommitdiff
path: root/docs/text.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2024-09-09 05:31:25 -0400
committerBruce Hill <bruce@bruce-hill.com>2024-09-09 05:31:25 -0400
commite16792d5eb76326634cb1ad0b21301ec693fccb3 (patch)
tree99e5b5c53db39e173db2b82db87cef85cd267c60 /docs/text.md
parent319d4306b585569d198a6e0ac268c009eb63705a (diff)
Add Text.starts_with() and Text.ends_with()
Diffstat (limited to 'docs/text.md')
-rw-r--r--docs/text.md66
1 files changed, 59 insertions, 7 deletions
diff --git a/docs/text.md b/docs/text.md
index 02c30912..8a9f641e 100644
--- a/docs/text.md
+++ b/docs/text.md
@@ -494,6 +494,32 @@ An array of 32-bit integer Unicode code points (`[Int32]`).
---
+## `ends_with`
+
+**Description:**
+Checks if the `Text` ends with a literal suffix text.
+
+**Usage:**
+```tomo
+ends_with(text: Text, suffix: Text) -> Bool
+```
+
+**Parameters:**
+
+- `text`: The text to be searched.
+- `suffix`: The literal suffix text to check for.
+
+**Returns:**
+`yes` if the text has the target, `no` otherwise.
+
+**Example:**
+```tomo
+>> "hello world":ends_with("world")
+= yes
+```
+
+---
+
## `from_c_string`
**Description:**
@@ -614,7 +640,7 @@ See: [Patterns](#Patterns) for more information on patterns.
**Usage:**
```tomo
-find(text: Text, pattern: Text, start: Int = 1, length: &Int64? = !&Int64) -> Int
+find(text: Text, pattern: Pattern, start: Int = 1, length: &Int64? = !&Int64) -> Int
```
**Parameters:**
@@ -657,7 +683,7 @@ See: [Patterns](#Patterns) for more information on patterns.
**Usage:**
```tomo
-find_all(text: Text, pattern: Text) -> [Text]
+find_all(text: Text, pattern: Pattern) -> [Text]
```
**Parameters:**
@@ -699,7 +725,7 @@ Checks if the `Text` contains a target pattern (see: [Patterns](#Patterns)).
**Usage:**
```tomo
-has(text: Text, pattern: Text) -> Bool
+has(text: Text, pattern: Pattern) -> Bool
```
**Parameters:**
@@ -816,7 +842,7 @@ Checks if the `Text` matches target pattern (see: [Patterns](#Patterns)).
**Usage:**
```tomo
-matches(text: Text, pattern: Text) -> Bool
+matches(text: Text, pattern: Pattern) -> Bool
```
**Parameters:**
@@ -847,7 +873,7 @@ calling the given function on that text.
**Usage:**
```tomo
-map(text: Text, pattern: Text, fn: func(text:Text)->Text) -> Text
+map(text: Text, pattern: Pattern, fn: func(text:Text)->Text) -> Text
```
**Parameters:**
@@ -931,7 +957,7 @@ See [Patterns](#patterns) for more information about patterns.
**Usage:**
```tomo
-replace(text: Text, pattern: Text, replacement: Text, backref: Pattern = $/\/, recursive: Bool = yes) -> Text
+replace(text: Text, pattern: Pattern, replacement: Text, backref: Pattern = $/\/, recursive: Bool = yes) -> Text
```
**Parameters:**
@@ -1045,7 +1071,7 @@ See [Patterns](#patterns) for more information about patterns.
**Usage:**
```tomo
-split(text: Text, pattern: Text = "") -> [Text]
+split(text: Text, pattern: Pattern = "") -> [Text]
```
**Parameters:**
@@ -1074,6 +1100,32 @@ An array of substrings resulting from the split.
---
+## `starts_with`
+
+**Description:**
+Checks if the `Text` starts with a literal prefix text.
+
+**Usage:**
+```tomo
+starts_with(text: Text, prefix: Text) -> Bool
+```
+
+**Parameters:**
+
+- `text`: The text to be searched.
+- `prefix`: The literal prefix text to check for.
+
+**Returns:**
+`yes` if the text has the given prefix, `no` otherwise.
+
+**Example:**
+```tomo
+>> "hello world":starts_with("hello")
+= yes
+```
+
+---
+
## `title`
**Description:**