open-nomad/website/content/docs/job-specification/hcl2/functions/string/substr.mdx

31 lines
524 B
Plaintext

---
layout: docs
page_title: substr - Functions - Configuration Language
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
```shell-session
> substr("hello world", 1, 4)
ello
```
The offset and length are both counted in _unicode characters_ rather than
bytes:
```shell-session
> substr("🤔🤷", 0, 1)
🤔
```