Skip to main content

FetchDump

This item is only intended to be used by the module's authors. Private

An internal module that handles fetching the Roblox API dump from the Roblox API. It is accessed by the fetchDump function on the Dump class.

Functions​

fetchLatestVersionHash​

</>
FetchDump.fetchLatestVersionHash() → string

Fetches the latest Roblox version hash from the Roblox API.

fetchVersionHash​

</>
FetchDump.fetchVersionHash(version: string?) → string

Fetches the Roblox version hash for the given version from the Roblox API. If no version is provided, it will default to the current version.

fetchVersionHashWithFallback​

</>
FetchDump.fetchVersionHashWithFallback(version: string?) → string

Fetches the Roblox version hash for the given version from the Roblox API. If no version is provided, it will default to the current version. If the version hash cannot be found within the deployment history, it will fallback to the latest version hash on the server.

fetchDump​

</>
FetchDump.fetchDump(hashOrVersion: string?) → (
APIDump,
versionHash
)

Fetches the API dump for the current version of Roblox from the Roblox API. If a hash or version is provided, it will attempt to fetch the dump for that hash or version.

Show raw api
{
    "functions": [
        {
            "name": "fetchLatestVersionHash",
            "desc": "Fetches the latest Roblox version hash from the Roblox API.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 40,
                "path": "src/FetchDump.lua"
            }
        },
        {
            "name": "fetchVersionHash",
            "desc": "Fetches the Roblox version hash for the given version from the\nRoblox API. If no version is provided, it will default to the\ncurrent version.",
            "params": [
                {
                    "name": "version",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 57,
                "path": "src/FetchDump.lua"
            }
        },
        {
            "name": "fetchVersionHashWithFallback",
            "desc": "Fetches the Roblox version hash for the given version from the\nRoblox API. If no version is provided, it will default to the\ncurrent version. If the version hash cannot be found within the\ndeployment history, it will fallback to the latest version hash\non the server.",
            "params": [
                {
                    "name": "version",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 92,
                "path": "src/FetchDump.lua"
            }
        },
        {
            "name": "fetchDump",
            "desc": "Fetches the API dump for the current version of Roblox from the\nRoblox API. If a hash or version is provided, it will attempt to\nfetch the dump for that hash or version.",
            "params": [
                {
                    "name": "hashOrVersion",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(APIDump, versionHash)"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 112,
                "path": "src/FetchDump.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FetchDump",
    "desc": "An internal module that handles fetching the Roblox API dump\nfrom the Roblox API. It is accessed by the [`fetchDump`][Dump.fetchDump]\nfunction on the [`Dump`][Dump] class.",
    "private": true,
    "source": {
        "line": 10,
        "path": "src/FetchDump.lua"
    }
}