mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-21 10:47:34 -05:00
4c0bda5386
Co-authored-by: Damian Stasik <920747+damianstasik@users.noreply.github.com> Co-authored-by: Roman Grinovski <roman.grinovski@gmail.com>
33 lines
813 B
Plaintext
33 lines
813 B
Plaintext
---
|
|
sidebar_label: tostring
|
|
description: The tostring function converts a value to a string.
|
|
---
|
|
|
|
# `tostring` Function
|
|
|
|
`tostring` converts its argument to a string value.
|
|
|
|
Explicit type conversions are rarely necessary in OpenTofu because it will
|
|
convert types automatically where required. Use the explicit type conversion
|
|
functions only to normalize types returned in module outputs.
|
|
|
|
Only the primitive types (string, number, and bool) and `null` can be converted to string.
|
|
`tostring(null)` produces a `null` value of type `string`. All other values produce an error.
|
|
|
|
## Examples
|
|
|
|
```
|
|
> tostring("hello")
|
|
"hello"
|
|
> tostring(1)
|
|
"1"
|
|
> tostring(true)
|
|
"true"
|
|
> tostring(null)
|
|
tostring(null)
|
|
> tostring([])
|
|
Error: Invalid function argument
|
|
|
|
Invalid value for "v" parameter: cannot convert tuple to string.
|
|
```
|