Skip to main content

RobloxApiDumpDataService

Functions​

GetRobloxApiDump​

</>
RobloxApiDumpDataService.GetRobloxApiDump(self: RobloxApiDumpDataService) → RobloxApiDump

Returns the Roblox API dump, which is cached for the lifetime of this service. This will error if no promiseApiDumpCallback has been set.

SetPromiseApiDump​

</>
RobloxApiDumpDataService.SetPromiseApiDump(
promiseApiDump: RobloxApiDump.PromiseDumpCallback
) → () → ()--

Function to clear the callback

Sets the promise dump callback which will be used to retrieve the Roblox API dump. This should only be set once, and will be cached for the lifetime of this service.

Show raw api
{
    "functions": [
        {
            "name": "GetRobloxApiDump",
            "desc": "Returns the Roblox API dump, which is cached for the lifetime of this service. This will error if no promiseApiDumpCallback\nhas been set.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiDumpDataService"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RobloxApiDump"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/roblox-api-dump/src/Shared/RobloxApiDumpDataService.lua"
            }
        },
        {
            "name": "SetPromiseApiDump",
            "desc": "Sets the promise dump callback which will be used to retrieve the Roblox API dump. This should only be set once, and will be cached for the lifetime of this service.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RobloxApiDumpDataService"
                },
                {
                    "name": "promiseApiDump",
                    "desc": "",
                    "lua_type": "RobloxApiDump.PromiseDumpCallback"
                }
            ],
            "returns": [
                {
                    "desc": "Function to clear the callback",
                    "lua_type": "() -> ()"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 72,
                "path": "src/roblox-api-dump/src/Shared/RobloxApiDumpDataService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RobloxApiDumpDataService",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/roblox-api-dump/src/Shared/RobloxApiDumpDataService.lua"
    }
}