Skip to main content

RobloxApiDump

Entry point for the Roblox API dump, this class contains api surfaces to query the actual API.

Functions​

new​

</>
RobloxApiDump.new() → RobloxApiDump

Constructs a new RobloxApiDump which will cache all results for its lifetime.

PromiseClass​

</>
RobloxApiDump:PromiseClass(className: string) → RobloxApiClass

Promises the Roblox API class for the given class name.

PromiseMembers​

</>
RobloxApiDump:PromiseMembers(className: string) → {RobloxApiMember}

Promises all Roblox API members.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new RobloxApiDump which will cache all results for its lifetime.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RobloxApiDump"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/roblox-api-dump/src/Server/RobloxApiDump.lua"
            }
        },
        {
            "name": "PromiseClass",
            "desc": "Promises the Roblox API class for the given class name.",
            "params": [
                {
                    "name": "className",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RobloxApiClass"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 39,
                "path": "src/roblox-api-dump/src/Server/RobloxApiDump.lua"
            }
        },
        {
            "name": "PromiseMembers",
            "desc": "Promises all Roblox API members.",
            "params": [
                {
                    "name": "className",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ RobloxApiMember }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "src/roblox-api-dump/src/Server/RobloxApiDump.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RobloxApiDump",
    "desc": "Entry point for the Roblox API dump, this class contains api surfaces to\nquery the actual API.",
    "source": {
        "line": 6,
        "path": "src/roblox-api-dump/src/Server/RobloxApiDump.lua"
    }
}