Regex replace operations

examples/index.json

@@ -1194,6 +1194,13 @@
         "verifyBuild": true,
         "verifyOutput": true,
         "isLearnByExample": true
+      },
+      {
+        "name": "RegExp replace operations",
+        "url": "regexp-replace-operations",
+        "verifyBuild": true,
+        "verifyOutput": true,
+        "isLearnByExample": true
       }
     ]
   },

examples/regexp-replace-operations/regexp_replace_operations.bal

@@ -0,0 +1,23 @@
+import ballerina/io;
+
+public function main() {
+    string creditCardNumber = "1234-5678-9876-5432";
+    string:RegExp pattern = re `(\d{4})-(\d{4})-(\d{4})`;
+    // Replaces the first occurrence of the credit card pattern with a masked representation.
+    string maskedCardNumber = pattern.replace(creditCardNumber, "****-****-****");
+    io:println(maskedCardNumber);
+
+    string xmlString = "<root>" +
+            "<!-- This is a comment -->" +
+            "<element1>Value 1</element1>" +
+            "<element2>Value 2</element2>" +
+            "<!-- Another comment -->" +
+            "<element3>Value 3</element3>" +
+        "</root>";
+
+    // Regular expression to match XML comments
+    string:RegExp commentPattern = re `<!--.*?-->`;
+    // Replaces all occurrences of XML comments with an empty string, effectively removing them.
+    string commentsRemoved = commentPattern.replaceAll(xmlString, "");
+    io:println(string `Comments removed XML: ${commentsRemoved}`);
+}

examples/regexp-replace-operations/regexp_replace_operations.md

@@ -0,0 +1,12 @@
+# RegExp operations
+
+The ``RegExp`` type supports a set of anguage library functions for replacing patterns in strings.
+
+::: code regexp_replace_operations.bal :::
+
+::: out regexp_replace_operations.out :::
+
+## Related links
+- [RegExp type](/learn/by-example/regexp-type)
+- [RegExp API Docs](https://lib.ballerina.io/ballerina/lang.regexp)
+- [string API Docs](https://lib.ballerina.io/ballerina/lang.string)

examples/regexp-replace-operations/regexp_replace_operations.metatags

@@ -0,0 +1,2 @@
+description: This BBE demonstrates how to use the regexp langlib functions relevant to regex replace operations.
+keywords: ballerina, ballerina by example, bbe, regexp, RegExp, regex, regular expressions, ballerina regex functions, regexp langlib functions, replace, replaceAll

examples/regexp-replace-operations/regexp_replace_operations.out

@@ -0,0 +1,3 @@
+$ bal run regexp_replace_operations.bal
+****-****-****-5432
+Comments removed XML: <root><element1>Value 1</element1><element2>Value 2</element2><element3>Value 3</element3></root>