open-nomad/website/content/docs/job-specification/hcl2/functions/string/replace.mdx

32 lines
797 B
Plaintext

---
layout: docs
page_title: replace - Functions - Configuration Language
description: |-
The replace function searches a given string for another given substring,
and replaces all occurrences with a given replacement string.
---
# `replace` Function
`replace` searches a given string for another given substring, and replaces
each occurrence with a given replacement string.
```hcl
replace(string, substring, replacement)
```
## Examples
```shell-session
> replace("1 + 2 + 3", "+", "-")
1 - 2 - 3
> replace("hello world", "world", "everybody")
hello everybody
```
## Related Functions
- [`regex_replace`](/docs/job-specification/hcl2/functions/string/regex_replace) searches a given string for another given substring,
and replaces each occurrence with a given replacement string.