Show raw api
{
"functions": [
{
"name": "username",
"desc": "Generates a random username.\n\n```lua\nprint(LipsumUtils.username()) --> LoremIpsum23\n```",
"params": [
{
"name": "optionalRandom",
"desc": "Optional random",
"lua_type": "Random?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 29,
"path": "src/lipsum/src/Shared/LipsumUtils.lua"
}
},
{
"name": "word",
"desc": "Generates a random word.\n\n```lua\nprint(LipsumUtils.word()) --> Lipsum\n```",
"params": [
{
"name": "random",
"desc": "Optional random",
"lua_type": "Random?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 70,
"path": "src/lipsum/src/Shared/LipsumUtils.lua"
}
},
{
"name": "words",
"desc": "Generates a random set of words space-separated.\n\n```lua\nprint(LipsumUtils.words(5)) --> 5 words\n```",
"params": [
{
"name": "numWords",
"desc": "",
"lua_type": "number"
},
{
"name": "random",
"desc": "Optional random",
"lua_type": "Random?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 85,
"path": "src/lipsum/src/Shared/LipsumUtils.lua"
}
},
{
"name": "sentence",
"desc": "Generates a random sentence.\n\n```lua\nprint(LipsumUtils.sentence(7)) --> Sentence with 7 words.\n```",
"params": [
{
"name": "numWords",
"desc": "Defaults to a random number 6 to 12.",
"lua_type": "number?"
},
{
"name": "optionalRandom",
"desc": "Optional random",
"lua_type": "Random?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 112,
"path": "src/lipsum/src/Shared/LipsumUtils.lua"
}
},
{
"name": "paragraph",
"desc": "Generates a random paragraph.\n\n```lua\nprint(LipsumUtils.paragraph(4)) --> Paragraph with 4 sentences.\n```",
"params": [
{
"name": "numSentences",
"desc": "",
"lua_type": "number?"
},
{
"name": "createSentence",
"desc": "Optional createSentence",
"lua_type": "(() -> string)?"
},
{
"name": "optionalRandom",
"desc": "Optional random",
"lua_type": "Random?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 155,
"path": "src/lipsum/src/Shared/LipsumUtils.lua"
}
},
{
"name": "document",
"desc": "```lua\nprint(LipsumUtils.document(3)) --> Document with 3 paragraphs\n```",
"params": [
{
"name": "numParagraphs",
"desc": "",
"lua_type": "number?"
},
{
"name": "createParagraph",
"desc": "Optional createParagraph",
"lua_type": "(() -> string)?"
},
{
"name": "random",
"desc": "Optional random",
"lua_type": "Random?"
}
],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "static",
"source": {
"line": 188,
"path": "src/lipsum/src/Shared/LipsumUtils.lua"
}
}
],
"properties": [],
"types": [],
"name": "LipsumUtils",
"desc": "Helpers to generate test text for a variety of situations, in the standard Lorem-Ipsum utility system.",
"source": {
"line": 6,
"path": "src/lipsum/src/Shared/LipsumUtils.lua"
}
}