strings.substring() function

strings.substring() returns a substring based on start and end parameters. These parameters are represent indices of UTF code points in the string.

When start or end are past the bounds of the string, respectively the start or end of the string is assumed. When end is less than or equal to start an empty string is returned.

Function type signature

(end: int, start: int, v: string) => string

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

v

({{< req >}}) String value to search for.

start

({{< req >}}) Starting inclusive index of the substring.

end

({{< req >}}) Ending exclusive index of the substring.

Examples

Return part of a string based on character index

import "sampledata"
import "strings"

sampledata.string()
    |> map(fn: (r) => ({r with _value: strings.substring(v: r._value, start: 5, end: 9)}))

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

Output data

{{% /expand %}} {{< /expand-wrapper >}}