Files
opentf/website/docs/configuration/functions/substr.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

32 lines
523 B
Markdown

---
layout: "functions"
page_title: "substr function"
sidebar_current: "docs-funcs-string-substr"
description: |-
The substr function extracts a substring from a given string by offset and
length.
---
# `substr` Function
`substr` extracts a substring from a given string by offset and length.
```hcl
substr(string, offset, length)
```
## Examples
```
> substr("hello world", 1, 4)
ello
```
The offset and length are both counted in _unicode characters_ rather than
bytes:
```
> substr("🤔🤷", 0, 1)
🤔
```