Module string

This module extends the functionality contained in the string table for convenience.

See the official string documentation for other functions that are available in the string table.

Since the string table is the hardwired __index table for string objects you can call them using the short : notion.

Usage:

    local str = 'Hello World'
    print(string.startsWith(str, 'Hello'))     -- Prints true
    print(str:startsWith('Hello'))             -- Equivalent to previous line
    
    -- Note that you have to put parentheses () around a string if you want to call a function on it directly
    print(('Hello World'):startsWith('Hello')) -- Prints true
    
    print(Array(str:split(' ')))               -- Prints {Hello, World}
    print(str:split(' ')[1])                   -- Prints Hello
    print(str:split(' ')[2])                   -- Prints World

Functions

contains (needle) Returns true iff the string matches the given Lua pattern.
endsWith (part) Checks whether the string ends with the given string.
split (sep) Splits the string into non-empty fields using separator characters.
startsWith (part) Checks whether the string starts with the given string.
trim () Removes whitespace from the start and end of the string.


Functions

contains (needle)
Returns true iff the string matches the given Lua pattern.

Parameters:

  • needle string The Lua pattern to search for (escape pattern characters to search for them literally).

Returns:

    bool True if the pattern matches somewhere in the string.
endsWith (part)
Checks whether the string ends with the given string.

Parameters:

  • part string The string to check if it ends with it.

Returns:

    bool True iff self ends with the string part.
split (sep)
Splits the string into non-empty fields using separator characters. Adjacent separators are skipped; the default separator is ':'. Uses implementation from here.

Parameters:

  • sep string Separator characters, e.g. ',' (Lua pattern character classes such as '%s' also work). This is not a literal multi-character delimiter.

Returns:

    table A table containing the fields.
startsWith (part)
Checks whether the string starts with the given string.

Parameters:

  • part string The string to check if it starts with it.

Returns:

    bool True iff self starts with the string part.
trim ()
Removes whitespace from the start and end of the string.

Returns:

    string The string without starting and ending spaces.
generated by LDoc 1.4.3 Last updated 2026-11-20 13:32:29