string

  6 minute read  

Chainable Ops

string-notEqual

Determines inequality of two values.

Argument
lhs	The first value to compare.
rhs	The second value to compare.

Return Value

Whether the two values are not equal.

string-add

Concatenates two strings

Argument
lhs	The first string
rhs	The second string

Return Value

The concatenated string

string-equal

Determines equality of two values.

Argument
lhs	The first value to compare.
rhs	The second value to compare.

Return Value

Whether the two values are equal.

string-append

Appends a suffix to a string

Argument
str	The string to append to
suffix	The suffix to append

Return Value

The string with the suffix appended

string-contains

Checks if a string contains a substring

Argument
str	The string to check
sub	The substring to check for

Return Value

Whether the string contains the substring

string-endsWith

Checks if a string ends with a suffix

Argument
str	The string to check
suffix	The suffix to check for

Return Value

Whether the string ends with the suffix

string-findAll

Finds all occurrences of a substring in a string

Argument
str	The string to find occurrences of the substring in
sub	The substring to find

Return Value

The list of indices of the substring in the string

string-isAlnum

Checks if a string is alphanumeric

Argument
str	The string to check

Return Value

Whether the string is alphanumeric

string-isAlpha

Checks if a string is alphabetic

Argument
str	The string to check

Return Value

Whether the string is alphabetic

string-isNumeric

Checks if a string is numeric

Argument
str	The string to check

Return Value

Whether the string is numeric

string-lStrip

Strip leading whitespace

Argument
str	The string to strip.

Return Value

The stripped string.

string-len

Returns the length of a string

Argument
str	The string to check

Return Value

The length of the string

string-lower

Converts a string to lowercase

Argument
str	The string to convert to lowercase

Return Value

The lowercase string

string-partition

Partitions a string into a list of the strings

Argument
str	The string to split
sep	The separator to split on

Return Value

A list of strings: the string before the separator, the separator, and the string after the separator

string-prepend

Prepends a prefix to a string

Argument
str	The string to prepend to
prefix	The prefix to prepend

Return Value

The string with the prefix prepended

string-rStrip

Strip trailing whitespace

Argument
str	The string to strip.

Return Value

The stripped string.

string-replace

Replaces all occurrences of a substring in a string

Argument
str	The string to replace contents of
sub	The substring to replace
newSub	The substring to replace the old substring with

Return Value

The string with the replacements

string-slice

Slices a string into a substring based on beginning and end indices

Argument
str	The string to slice
begin	The beginning index of the substring
end	The ending index of the substring

Return Value

The substring

string-split

Splits a string into a list of strings

Argument
str	The string to split
sep	The separator to split on

Return Value

The list of strings

string-startsWith

Checks if a string starts with a prefix

Argument
str	The string to check
prefix	The prefix to check for

Return Value

Whether the string starts with the prefix

string-strip

Strip whitespace from both ends of a string.

Argument
str	The string to strip.

Return Value

The stripped string.

string-upper

Converts a string to uppercase

Argument
str	The string to convert to uppercase

Return Value

The uppercase string

string-levenshtein

Calculates the Levenshtein distance between two strings.

Argument
str1	The first string.
str2	The second string.

Return Value

The Levenshtein distance between the two strings.

List Ops

string-notEqual

Determines inequality of two values.

Argument
lhs	The first value to compare.
rhs	The second value to compare.

Return Value

Whether the two values are not equal.

string-add

Concatenates two strings

Argument
lhs	The first string
rhs	The second string

Return Value

The concatenated string

string-equal

Determines equality of two values.

Argument
lhs	The first value to compare.
rhs	The second value to compare.

Return Value

Whether the two values are equal.

string-append

Appends a suffix to a string

Argument
str	The string to append to
suffix	The suffix to append

Return Value

The string with the suffix appended

string-contains

Checks if a string contains a substring

Argument
str	The string to check
sub	The substring to check for

Return Value

Whether the string contains the substring

string-endsWith

Checks if a string ends with a suffix

Argument
str	The string to check
suffix	The suffix to check for

Return Value

Whether the string ends with the suffix

string-findAll

Finds all occurrences of a substring in a string

Argument
str	The string to find occurrences of the substring in
sub	The substring to find

Return Value

The list of indices of the substring in the string

string-isAlnum

Checks if a string is alphanumeric

Argument
str	The string to check

Return Value

Whether the string is alphanumeric

string-isAlpha

Checks if a string is alphabetic

Argument
str	The string to check

Return Value

Whether the string is alphabetic

string-isNumeric

Checks if a string is numeric

Argument
str	The string to check

Return Value

Whether the string is numeric

string-lStrip

Strip leading whitespace

Argument
str	The string to strip.

Return Value

The stripped string.

string-len

Returns the length of a string

Argument
str	The string to check

Return Value

The length of the string

string-lower

Converts a string to lowercase

Argument
str	The string to convert to lowercase

Return Value

The lowercase string

string-partition

Partitions a string into a list of the strings

Argument
str	The string to split
sep	The separator to split on

Return Value

A list of strings: the string before the separator, the separator, and the string after the separator

string-prepend

Prepends a prefix to a string

Argument
str	The string to prepend to
prefix	The prefix to prepend

Return Value

The string with the prefix prepended

string-rStrip

Strip trailing whitespace

Argument
str	The string to strip.

Return Value

The stripped string.

string-replace

Replaces all occurrences of a substring in a string

Argument
str	The string to replace contents of
sub	The substring to replace
newSub	The substring to replace the old substring with

Return Value

The string with the replacements

string-slice

Slices a string into a substring based on beginning and end indices

Argument
str	The string to slice
begin	The beginning index of the substring
end	The ending index of the substring

Return Value

The substring

string-split

Splits a string into a list of strings

Argument
str	The string to split
sep	The separator to split on

Return Value

The list of strings

string-startsWith

Checks if a string starts with a prefix

Argument
str	The string to check
prefix	The prefix to check for

Return Value

Whether the string starts with the prefix

string-strip

Strip whitespace from both ends of a string.

Argument
str	The string to strip.

Return Value

The stripped string.

string-upper

Converts a string to uppercase

Argument
str	The string to convert to uppercase

Return Value

The uppercase string

string-levenshtein

Calculates the Levenshtein distance between two strings.

Argument
str1	The first string.
str2	The second string.

Return Value

The Levenshtein distance between the two strings.