Files
opentf/website/docs/configuration/functions/length.html.md
Martin Atkins e7d71995f6 website: Document the remaining "collection" functions
This also renames some of the existing function pages whose source
filenames were not matching the usual naming scheme (.html.md).
2018-10-16 18:47:33 -07:00

1.1 KiB

layout, page_title, sidebar_current, description
layout page_title sidebar_current description
functions length function docs-funcs-collection-length The length function determines the length of a collection or string.

length Function

length determines the length of a given list, map, or string.

If given a list or map, the result is the number of elements in that collection. If given a string, the result is the number of characters in the string.

Examples

> length([])
0
> length(["a", "b"])
2
> length({"a" = "b"})
1
> length("hello")
5

When given a string, the result is the number of characters, rather than the number of bytes or Unicode sequences that form them:

> length("👾🕹️")
2

A "character" is a grapheme cluster, as defined by Unicode Standard Annex #29. Note that remote APIs may have a different definition of "character" for the purpose of length limits on string arguments; a Terraform provider is responsible for translating Terraform's string representation into that used by its respective remote system and applying any additional validation rules to it.