# 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
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, error)
|
{% tabs %}
{% tab title="Template Example" %}
{{ "hello world" | regexFind "hello" }} // Output: "hello", nil
{{ "hello world" | regexFind "\invalid$^///" }} // Error
{% endtab %}
{% endtabs %}
### regexFindAll
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, error)
|
{% tabs %}
{% tab title="Template Example" %}
```go
{{ regexFindAll "a.", "aba acada afa", 3 }} // Output: ["ab", "ac", "af"], nil
{{ regexFindAll "\invalid$^///", "aba acada afa", 3 }} // Error
```
{% endtab %}
{% endtabs %}
### regexMatch
The function checks if the entire string matches the given regular expression pattern.
| Name | Value |
|---|
| Signature | RegexMatch(regex string, s string) (bool, error)
|
{% tabs %}
{% tab title="Template Example" %}
```go
{{ regexMatch "^[a-zA-Z]+$", "Hello" }} // Output: true, nil
{{ regexMatch "\invalid$^///", "Hello" }} // Output: false, error
```
{% endtab %}
{% endtabs %}
### regexSplit
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, error)
|
{% tabs %}
{% tab title="Template Example" %}
```go
{{ mustRegexSplit "\\s+", "hello world from Go", 2 }} // Output: ["hello", "world from Go"], nil
{{ mustRegexSplit "\invalid$^///", "hello world from Go", 2 }} // Error
```
{% endtab %}
{% endtabs %}
### regexReplaceAll
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, error)
|
{% tabs %}
{% tab title="Template Example" %}
```go
{{ regexReplaceAll "\\d", "R2D2 C3PO", "X" }} // Output: "RXDX CXPO", nil
{{ regexReplaceAll "\invalid$^///", "R2D2 C3PO", "X" }} // Output: "", error
```
{% endtab %}
{% endtabs %}
### regexReplaceAllLiteral
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, error)
|
{% tabs %}
{% tab title="Template Example" %}
```go
{{ regexReplaceAllLiteral "world", "hello world", "$1" }} // Output: "hello $1", nil
{{ regexReplaceAllLiteral "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
|
{% 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/1eETtqCYtVeEPVLnbGs0/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.