summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/strings/SliceString.md
blob: ee4ed908145c76586e41f421ae72ce7906a23b19 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
---
title: strings.SliceString
description: Returns a substring of the given string, beginning with the start position and ending before the end position.
categories: []
keywords: []
action:
  aliases: [slicestr]
  related:
    - functions/strings/Substr
  returnType: string
  signatures: ['strings.SliceString STRING [START] [END]']
aliases: [/functions/slicestr]
---

The START and END positions are zero-based, where `0` represents the first character of the string. If START is not specified, the substring will begin at position `0`. If END is not specified, the substring will end after the last character.

```go-html-template
{{ slicestr "BatMan" }} → BatMan
{{ slicestr "BatMan" 3 }} → Man
{{ slicestr "BatMan" 0 3 }} → Bat
```

The START and END arguments represent the endpoints of a [half-open interval], a concept that may be difficult to grasp when first encountered. You may find that the [`strings.Substr`] function is easier to understand.

[half-open interval]: /getting-started/glossary/#interval
[`strings.Substr`]: /functions/strings/substr/