# Strings {% hint style="info" %} You can easily import all the functions from the `strings` registry by including the following import statement in your code ```go import "github.com/go-sprout/sprout/registry/strings" ``` {% endhint %} ### nospace The function removes all whitespace characters from the provided string, eliminating any spaces, tabs, or line breaks.
NameValue
Signature
Nospace(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | nospace }} // Output: HelloWorld ``` {% endtab %} {% endtabs %} ### trim The function removes any leading and trailing whitespace from the provided string.
NameValue
Signature
Trim(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ " Hello World " | trim }} // Output: Hello World ``` {% endtab %} {% endtabs %} ### trimAll The function removes all instances of any characters in the 'cutset' from both the beginning and the end of the provided string.
NameValue
Signature
TrimAll(cutset string, str string)
{% tabs %} {% tab title="Template Example" %} ```go {{ "xyzHelloxyz" | trimAll "xyz" }} // Output: Hello ``` {% endtab %} {% endtabs %} ### trimPrefix The function removes the specified 'prefix' from the start of the provided string if it is present.
NameValue
Signature
TrimPrefix(prefix string, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "HelloWorld" | trimPrefix "Hello" }} // Output: World {{ "HelloWorld" | trimPrefix "World" }} // Output: HelloWorld ``` {% endtab %} {% endtabs %} ### trimSuffix The function removes the specified 'suffix' from the end of the provided string if it is present.
NameValue
Signature
TrimSuffix(suffix string, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "HelloWorld" | trimSuffix "Hello" }} // Output: HelloWorld {{ "HelloWorld" | trimSuffix "World" }} // Output: Hello ``` {% endtab %} {% endtabs %} ### contains The function checks whether the provided string contains the specified substring.
NameValue
Signature
Contains(substring string, str string) bool
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello" | contains "ell" }} // Output: true ``` {% endtab %} {% endtabs %} ### hasPrefix The function checks whether the provided string starts with the specified prefix.
NameValue
Signature
HasPrefix(prefix string, str string) bool
{% tabs %} {% tab title="Template Example" %} ```go {{ "HelloWorld" | hasPrefix "Hello" }} // Output: true ``` {% endtab %} {% endtabs %} ### hasSuffix The function checks whether the provided string ends with the specified suffix.
NameValue
Signature
HasSuffix(suffix string, str string) bool
{% tabs %} {% tab title="Template Example" %} ```go {{ "HelloWorld" | hasSuffix "World" }} // Output: true ``` {% endtab %} {% endtabs %} ### toLower The function converts all characters in the provided string to lowercase.
NameValue
Signature
ToLower(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "HELLO WORLD" | toLower }} // Output: hello world ``` {% endtab %} {% endtabs %} ### toUpper The function converts all characters in the provided string to uppercase.
NameValue
Signature
ToUpper(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | toUpper }} // Output: HELLO WORLD ``` {% endtab %} {% endtabs %} ### replace The function replaces all occurrences of a specified substring ('old') in the source string with a new substring ('new').
NameValue
Signature
Replace(old string, new string, src string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "banana" | replace "a" "o" }} // Output: bonono ``` {% endtab %} {% endtabs %} ### repeat The function repeats the provided string a specified number of times.
NameValue
Signature
Repeat(count int, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "ha" | repeat 3 }} // Output: hahaha ``` {% endtab %} {% endtabs %} ### join The function concatenates elements of a slice into a single string, with each element separated by a specified delimiter. It can convert various slice types to a slice of strings if needed before joining.
NameValue
Signature
Join(sep string, v any) string
{% tabs %} {% tab title="Template Example" %} ```go {{- $list := list "apple" "banana" "cherry" -}} {{ $list | join ", " }} // Output: apple, banana, cherry ``` {% endtab %} {% endtabs %} ### trunc The function truncates the provided string to a maximum specified length. If the length is negative, it removes the specified number of characters from the beginning of the string.
NameValue
Signature
Trunc(count int, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | trunc 5 }} // Output: Hello {{ "Hello World" | trunc -5 }} // Output: World ``` {% endtab %} {% endtabs %} ### shuffle The function randomly rearranges the characters in the provided string, producing a shuffled version of the original string.
NameValue
Signature
Shuffle(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello" | shuffle }} // Output(will be different): "loleh" ``` {% endtab %} {% endtabs %} ### ellipsis The function truncates a string to a specified maximum width and appends an ellipsis ("...") if the string exceeds that width.
NameValue
Signature
Ellipsis(maxWidth int, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | ellipsis 10 }} // Output: Hello W... ``` {% endtab %} {% endtabs %} ### ellipsisBoth The function truncates a string from both ends, preserving the middle portion and adding ellipses ("...") to both ends if the string exceeds the specified length.
NameValue
Signature
EllipsisBoth(offset int, maxWidth int, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | ellipsisBoth 1 10 }} // Output: ...ello... ``` {% endtab %} {% endtabs %} ### initials The function extracts initials from a string, optionally using specified delimiters to identify word boundaries.
NameValue
Signature
Initials(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "John Doe" | initials }} // Output: JD ``` {% endtab %} {% endtabs %} ### plural The function returns a specified string ('one') if the count is 1; otherwise, it returns an alternative string ('many').
NameValue
Signature
Plural(one, many string, count int) string
{% tabs %} {% tab title="Template Example" %} ```go {{ 1 | plural "apple" "apples" }} // Output: apple {{ 2 | plural "apple" "apples" }} // Output: apples ``` {% endtab %} {% endtabs %} ### wrap The function breaks a string into lines, ensuring that each line does not exceed a specified maximum length. It avoids splitting words across lines unless absolutely necessary.
NameValue
Signature
Wrap(length int, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "This is a long string that needs to be wrapped." | wrap 10 }} // Output: This is a\nlong\nstring\nthat needs\nto be\nwrapped. ``` {% endtab %} {% endtabs %} ### wrapWith The function breaks a string into lines with a specified maximum length, using a custom newline character to separate the lines. It only wraps words when they exceed the maximum line length.
NameValue
Signature
WrapWith(length int, newLineCharacter string, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "This is a long string that needs to be wrapped." | wrapWith 10 "
" }} // Output: This is a
long
string
that needs
to be
wrapped. ``` {% endtab %} {% endtabs %} ### quote The function wraps each element in a provided list with double quotes and separates them with spaces.
NameValue
Signature
Quote(elements ...any) string
{% tabs %} {% tab title="Template Example" %} ```go {{- $list := list "hello" "world" 123 -}} {{ $list | quote }} // Output(human readable): "hello" "world" "123" ``` {% endtab %} {% endtabs %} ### squote The function wraps each element in the provided list with single quotes and separates them with spaces.
NameValue
Signature
Squote(elements ...any) string
{% tabs %} {% tab title="Template Example" %} ```go {{- $list := list "hello" "world" 123 -}} {{ $list | squote }} // Output(human readable): 'hello' 'world' '123' ``` {% endtab %} {% endtabs %} ### toCamelCase Converts a string to `camelCase` format.
NameValue
Signature
ToCamelCase(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | toCamelCase }} // Output: helloWorld ``` {% endtab %} {% endtabs %} ### toKebabCase Converts a string to `kebab-case` format.
NameValue
Signature
ToKebabCase(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | toKebabCase }} // Output: hello-world ``` {% endtab %} {% endtabs %} ### toPascalCase Converts a string to `PascalCase` format.
NameValue
Signature
ToPascalCase(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | toPascalCase }} // Output: HelloWorld ``` {% endtab %} {% endtabs %} ### toDotCase Converts a string to `dot.case` format.
NameValue
Signature
ToDotCase(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | toDotCase }} // Output: hello.world ``` {% endtab %} {% endtabs %} ### toPathCase Converts a string to `path/case` format.
NameValue
Signature
ToPathCase(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | toPathCase }} // Output: hello/world ``` {% endtab %} {% endtabs %} ### toConstantCase Converts a string to `CONSTANT_CASE` format.
NameValue
Signature
ToConstantCase(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | toConstantCase }} // Output: HELLO_WORLD ``` {% endtab %} {% endtabs %} ### toSnakeCase Converts a string to `snake_case` format.
NameValue
Signature
ToSnakeCase(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | toSnakeCase }} // Output: hello_world ``` {% endtab %} {% endtabs %} ### toTitleCase Converts a string to `Title Case` format.
NameValue
Signature
ToTitleCase(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | toTitleCase }} // Output: Hello World ``` {% endtab %} {% endtabs %} ### untitle Converts the first letter of each word in a string to lowercase.
NameValue
Signature
Untitle(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | untitle }} // Output: hello world ``` {% endtab %} {% endtabs %} ### swapCase Switches the case of each letter in a string, converting lowercase to uppercase and vice versa.
NameValue
Signature
SwapCase(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | swapCase }} // Output: hELLO wORLD ``` {% endtab %} {% endtabs %} ### capitalize Uppercases the first letter of a string while leaving the rest of the string unchanged.
NameValue
Signature
capitalize(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "hello world" | capitalize }} // Output: Hello world {{ "123boo_bar" | capitalize }} // Output: 123Boo_bar {{ " Fe bar" | capitalize }} // Output: " Fe bar" ``` {% endtab %} {% endtabs %} ### uncapitalize Lowercases the first letter of a string while leaving the rest of the string unchanged.
NameValue
Signature
uncapitalize(str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | uncapitalize }} // Output: hello World {{ "123Boo_bar" | uncapitalize }} // Output: 123boo_bar {{ " Fe bar" | uncapitalize }} // Output: " fe bar" ``` {% endtab %} {% endtabs %} ### split Divides a string into a map of parts based on a specified separator, returning a collection of the split components.
NameValue
Signature
Split(sep, orig string) map[string]string
{% tabs %} {% tab title="Template Example" %} ```go {{ "apple,banana,cherry" | split "," }} // Output: map[_0:apple _1:banana _2:cherry] ``` {% endtab %} {% endtabs %} ### splitn Splits a string into a specified number of parts using a separator, returning a map with up to `n` elements.
NameValue
Signature
Splitn(sep string, n int, orig string) map[string]string
{% tabs %} {% tab title="Template Example" %} ```go {{ "apple,banana,cherry" | splitn "," 2 }} // Output: map[_0:apple _1:banana,cherry] ``` {% endtab %} {% endtabs %} ### substr Extracts a portion of a string based on given start and end positions, with support for negative indices to count from the end.
NameValue
Signature
Substring(start int, end int, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello World" | substr 0 5 }} // Output: Hello ``` {% endtab %} {% endtabs %} ### indent Adds spaces to the beginning of each line in a string, effectively indenting the text.
NameValue
Signature
Indent(spaces int, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello\nWorld" | indent 4 }} // Output: " Hello\n World" ``` {% endtab %} {% endtabs %} ### nindent Similar to `Indent`, but also adds a newline before the indented lines.
NameValue
Signature
Nindent(spaces int, str string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ "Hello\nWorld" | nindent 4 }} // Output: \n Hello\n World ``` {% endtab %} {% endtabs %} ### seq Generates a sequence of numbers as a string, allowing for customizable start, end, and step values, similar to the Unix `seq` command.
NameValue
Signature
Seq(params ...int) string
{% tabs %} {% tab title="Template Example" %} ```go {{ seq 1 2 10 }} // Output: 1 3 5 7 9 {{ seq 3 -3 2 }} // Output: 3 {{ seq }} // Output: "" {{ seq 0 4 }} // Output: 0 1 2 3 4 {{ seq -5 }} // Output: 1 0 -1 -2 -3 -4 -5 {{ seq 0 -4 }} // Output: 0 -1 -2 -3 -4 ``` {% endtab %} {% endtabs %} ### escape The function escapes specified characters in a string by prefixing them with a backslash. The backslash character itself is always implicitly included in the charset and escaped first. This is useful for preparing strings to be used with functions like `dig` that interpret escape sequences.
NameValue
Signature
Escape(charset string, value string) string
{% tabs %} {% tab title="Template Example" %} ```go {{ escape "." "example.com" }} // Output: example\.com {{ escape ".:" "a.b:c" }} // Output: a\.b\:c ``` {% endtab %} {% endtabs %} ### unescape The function reverses `escape` by removing backslash prefixes from specified characters. The backslash character itself is always implicitly included in the charset. Returns an error if an invalid escape sequence is found.
NameValue
Signature
Unescape(charset string, value string) (string, error)
{% tabs %} {% tab title="Template Example" %} ```go {{ unescape "." "example\\.com" }} // Output: example.com {{ unescape ".:" "a\\.b\\:c" }} // Output: a.b:c {{ "example.com" | escape "." | unescape "." }} // Output: example.com ``` {% endtab %} {% endtabs %}