Clarify the way the trim() function works and add some more examples

This commit is contained in:
Krista LaFentres 2021-10-22 16:42:17 -05:00
parent 5ca21afa75
commit 1f08f7dba8
1 changed files with 16 additions and 3 deletions

View File

@ -3,20 +3,33 @@ layout: "language"
page_title: "trim - Functions - Configuration Language" page_title: "trim - Functions - Configuration Language"
sidebar_current: "docs-funcs-string-trim" sidebar_current: "docs-funcs-string-trim"
description: |- 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. a given string.
--- ---
# `trim` Function # `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. 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 ## Examples
``` ```
> trim("?!hello?!", "!?") > trim("?!hello?!", "!?")
hello "hello"
> trim("foobar", "far")
"oob"
> trim(" hello! world.! ", "! ")
"hello! world."
``` ```
## Related Functions ## Related Functions