# Regexp {% hint style="info" %} You can easily import all the functions from the `regexp` registry by including the following import statement in your code ```go import "github.com/go-sprout/sprout/registry/regexp" ``` {% endhint %} ### regexFind / mustRegexFind The function returns the first match found in the string that corresponds to the specified regular expression pattern.

Name	Value
Signature	`RegexFind(regex string, s string) string MustRegexFind(regex string, s string) (string, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ regexFind "a(b+)" "aaabbb" }} // Output: "abbb" ``` {% endtab %} {% tab title="Must version" %}

{{ "hello world" | mustRegexFind "hello" }} // Output: "hello", nil
{{ "hello world" | mustRegexFind "\invalid$^///" }} // Output: "", error

{% endtab %} {% endtabs %} ### regexFindAll / mustRegexFindAll The function returns all matches of the regex pattern in the string, up to a specified maximum number of matches (`n`).

Name	Value
Signature	`RegexFindAll(regex string, s string, n int) []string MustRegexFindAll(regex string, s string, n int) ([]string, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ regexFindAll "a(b+)" "ababab" 2 }} // Output: ["ab", "ab"] ``` {% endtab %} {% tab title="Must version" %} ```go {{ mustRegexFindAll "a.", "aba acada afa", 3 }} // Output: ["ab", "ac", "af"], nil {{ mustRegexFindAll "\invalid$^///", "aba acada afa", 3 }} // Output: "", error ``` {% endtab %} {% endtabs %} ### regexMatch / mustRegexMatch The function checks if the entire string matches the given regular expression pattern.

Name	Value
Signature	`RegexMatch(regex string, s string) bool MustRegexMatch(regex string, s string) (bool, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ regexMatch "^[a-zA-Z]+$" "Hello" }} // Output: true ``` {% endtab %} {% tab title="Must version" %} ```go {{ mustRegexMatch "^[a-zA-Z]+$", "Hello" }} // Output: true, nil {{ mustRegexMatch "\invalid$^///", "Hello" }} // Output: false, error ``` {% endtab %} {% endtabs %} ### regexSplit / mustRegexSplit The function splits the string into substrings based on matches of the regex pattern, performing the split up to `n` times.

Name	Value
Signature	`RegexSplit(regex string, s string, n int) []string MustRegexSplit(regex string, s string, n int) ([]string, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{regexSplit "\\s+" "hello world" -1 }} // Output: ["hello", "world"] ``` {% endtab %} {% tab title="Must version" %} ```go {{ mustRegexSplit "\\s+", "hello world from Go", 2 }} // Output: ["hello", "world from Go"], nil {{ mustRegexSplit "\invalid$^///", "hello world from Go", 2 }} // Output: [], error ``` {% endtab %} {% endtabs %} ### regexReplaceAll / mustRegexReplaceAll The function replaces all occurrences of the regex pattern in the string with the specified replacement string.

Name	Value
Signature	`RegexReplaceAll(regex string, s string, repl string) string MustRegexReplaceAll(regex string, s string, repl string) (string, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ regexReplaceAll "[aeiou]" "hello" "i" }} // Output: "hillo" ``` {% endtab %} {% tab title="Must version" %} ```go {{ mustRegexReplaceAll "\\d", "R2D2 C3PO", "X" }} // Output: "RXDX CXPO", nil {{ mustRegexReplaceAll "\invalid$^///", "R2D2 C3PO", "X" }} // Output: "", error ``` {% endtab %} {% endtabs %} ### regexReplaceAllLiteral / mustRegexReplaceAllLiteral The function replaces all occurrences of the regex pattern in the string with the specified literal replacement string, without interpreting any special characters in the replacement.

Name	Value
Signature	`RegexReplaceAllLiteral(regex string, s string, repl string) string MustRegexReplaceAllLiteral(regex string, s string, repl string) (string, error)`
Must version	✅

{% tabs %} {% tab title="Template Example" %} ```go {{ regexReplaceAllLiteral "[aeiou]" "hello" "$&" }} // Output: "h$&ll$&" ``` {% endtab %} {% tab title="Must version" %} ```go {{ mustRegexReplaceAllLiteral "world", "hello world", "$1" }} // Output: "hello $1", nil {{ mustRegexReplaceAllLiteral "world", "hello world", "\invalid$^///" }} // Output: "", error ``` {% endtab %} {% endtabs %} ### regexQuoteMeta The function returns a version of the provided string that can be used as a literal pattern in a regular expression, escaping any special characters.

Name	Value
Signature	`RegexQuoteMeta(str string) string`
Must version	❌

{% tabs %} {% tab title="Template Example" %} ```go {{ regexQuoteMeta ".+*?^$()[]{}|" }} // Output: "\.\+\*\?\^\$\[\]\{\}\|" ``` {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.atom.codes/sprout/~/changes/gP9HOVz2PoFWbplTHwVo/registries/regexp.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.