Skip to main content

stringUtil

A simple utility module for working with strings.

Functions​

formatLongString​

</>
stringUtil.formatLongString(string: string) → string

Returns a formatted version of the given string (essentially just add in hiphens).

print(stringUtil.formatLongString("jail in the break")) --> "jail-in-the-break"
Show raw api
{
    "functions": [
        {
            "name": "formatLongString",
            "desc": "Returns a formatted version of the given string (essentially just add in hiphens).\n\n```lua\nprint(stringUtil.formatLongString(\"jail in the break\")) --> \"jail-in-the-break\"\n```",
            "params": [
                {
                    "name": "string",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 16,
                "path": "src/stringUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "stringUtil",
    "desc": "A simple utility module for working with strings.",
    "source": {
        "line": 6,
        "path": "src/stringUtil/init.luau"
    }
}