docs-v2/content/v2.0/reference/flux/functions/regexp/replaceallstring.md

60 lines
1.1 KiB
Markdown

---
title: regexp.replaceAllString() function
description: >
The `regexp.replaceAllString()` function replaces all regular expression matches
in a string with a specified replacement.
menu:
v2_0_ref:
name: regexp.replaceAllString
parent: Regular expressions
weight: 301
---
The `regexp.replaceAllString()` function replaces all regular expression matches
in a string with a specified replacement.
_**Output data type:** String_
```js
import "regexp"
regexp.replaceAllString(r: /a(x*)b/, v: "-ab-axxb-", t: "T")
// Returns "-T-T-"
```
## Parameters
### r
The regular expression used to search `v`.
_**Data type:** Regexp_
### v
The string value to search.
_**Data type:** String_
### t
The replacement for matches to `r`.
_**Data type:** String_
## Examples
###### Replace regular expression matches in string column values
```js
import "regexp"
data
|> map(fn: (r) => ({
r with
message: r.message,
updated_message: regexp.replaceAllString(
r: /cat|bird|ferret/,
v: r.message,
t: "dog"
)
}))
```