Show raw api
{
"functions": [
{
"name": "trim",
"desc": "Trims the string of the given pattern",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
},
{
"name": "pattern",
"desc": "Defaults to whitespace",
"lua_type": "string?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 16,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "toCamelCase",
"desc": "Converts the string to `UpperCamelCase` from `camelCase` or `snakeCase` or `YELL_CASE`",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 32,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "uppercaseFirstLetter",
"desc": "Uppercases the first letter of the string",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 46,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "toLowerCamelCase",
"desc": "Converts to the string to `lowerCamelCase` from `camelCase` or `snakeCase` or `YELL_CASE`",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 55,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "toPrivateCase",
"desc": "Converts the string to _privateCamelCase",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 69,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "trimFront",
"desc": "Like trim, but only applied to the beginning of the setring",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
},
{
"name": "pattern",
"desc": "Defaults to whitespace",
"lua_type": "string?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 79,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "checkNumOfCharacterInString",
"desc": "Counts the number of times a char appears in a string.\n\n:::note\nNote that this is not UTF8 safe\n:::",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
},
{
"name": "char",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 95,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "isEmptyOrWhitespaceOrNil",
"desc": "Checks if a string is empty or nil",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 108,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "isWhitespace",
"desc": "Returns whether or not text is only whitespace",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 117,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "elipseLimit",
"desc": "Converts text to have a ... after it if it's too long.",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
},
{
"name": "characterLimit",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 127,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "removePrefix",
"desc": "Removes a prefix from a string if it exists",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
},
{
"name": "prefix",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 141,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "removePostfix",
"desc": "Removes a postfix from a string if it exists",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
},
{
"name": "postfix",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 156,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "endsWith",
"desc": "Returns if a string ends with a postfix",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
},
{
"name": "postfix",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 171,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "startsWith",
"desc": "Returns if a string starts with a postfix",
"params": [
{
"name": "str",
"desc": "",
"lua_type": "string"
},
{
"name": "prefix",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 182,
"path": "src/string/src/Shared/String.lua"
}
},
{
"name": "addCommas",
"desc": "Adds commas to a number. Not culture aware.\n\nSee [NumberLocalizationUtils.abbreviate] for a culture aware version.",
"params": [
{
"name": "number",
"desc": "",
"lua_type": "string | number"
},
{
"name": "seperator",
"desc": "",
"lua_type": "string?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 195,
"path": "src/string/src/Shared/String.lua"
}
}
],
"properties": [],
"types": [],
"name": "String",
"desc": "This module provides utility functions for strings",
"source": {
"line": 6,
"path": "src/string/src/Shared/String.lua"
}
}