Merge pull request #29798 from hashicorp/lafentres/clarify-trim-docs
Clarify the way the trim() function works
This commit is contained in:
commit
9bb5a58e3c
|
@ -3,20 +3,33 @@ layout: "language"
|
|||
page_title: "trim - Functions - Configuration Language"
|
||||
sidebar_current: "docs-funcs-string-trim"
|
||||
description: |-
|
||||
The trim function removes the specified characters from the start and end of
|
||||
The trim function removes the specified set of characters from the start and end of
|
||||
a given string.
|
||||
---
|
||||
|
||||
# `trim` Function
|
||||
|
||||
`trim` removes the specified characters from the start and end of the given
|
||||
`trim` removes the specified set of characters from the start and end of the given
|
||||
string.
|
||||
|
||||
```hcl
|
||||
trim(string, str_character_set)
|
||||
```
|
||||
|
||||
Every occurrence of a character in the second argument is removed from the start
|
||||
and end of the string specified in the first argument.
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
> trim("?!hello?!", "!?")
|
||||
hello
|
||||
"hello"
|
||||
|
||||
> trim("foobar", "far")
|
||||
"oob"
|
||||
|
||||
> trim(" hello! world.! ", "! ")
|
||||
"hello! world."
|
||||
```
|
||||
|
||||
## Related Functions
|
||||
|
|
Loading…
Reference in New Issue