mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-01-14 14:02:13 -05:00
48d940323e
Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
1.4 KiB
1.4 KiB
layout, page_title, sidebar_current, description
| layout | page_title | sidebar_current | description |
|---|---|---|---|
| functions | formatlist function | docs-funcs-string-formatlist | The formatlist function produces a list of strings by formatting a number of other values according to a specification string. |
formatlist Function
formatlist produces a list of strings by formatting a number of other
values according to a specification string.
formatlist(spec, values...)
The specification string uses
the same syntax as format.
The given values can be a mixture of list and non-list arguments. Any given lists must be the same length, which decides the length of the resulting list.
The list arguments are iterated together in order by index, while the non-list arguments are used repeatedly for each iteration. The format string is evaluated once per element of the list arguments.
Examples
> formatlist("Hello, %s!", ["Valentina", "Ander", "Olivia", "Sam"])
[
"Hello, Valentina!",
"Hello, Ander!",
"Hello, Olivia!",
"Hello, Sam!",
]
> formatlist("%s, %s!", "Salutations", ["Valentina", "Ander", "Olivia", "Sam"])
[
"Salutations, Valentina!",
"Salutations, Ander!",
"Salutations, Olivia!",
"Salutations, Sam!",
]
Related Functions
formatdefines the specification syntax used by this function and produces a single string as its result.