Skip to main content

LoaderOptionUtils

Options controlling how the loader bootstraps.

Functions​

defaultOptions​

</>
LoaderOptionUtils.defaultOptions() → LoaderOptions

Options used when the caller does not specify any.

isLoaderOptions​

</>
LoaderOptionUtils.isLoaderOptions(options: any?) → boolean

Returns true if the argument is a valid set of loader options

createOptions​

</>
LoaderOptionUtils.createOptions(options: PartialLoaderOptions?) → LoaderOptions

Fills in whatever the caller left out.

Show raw api
{
    "functions": [
        {
            "name": "defaultOptions",
            "desc": "Options used when the caller does not specify any.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "LoaderOptions"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 45,
                "path": "src/loader/src/LoaderOptionUtils.lua"
            }
        },
        {
            "name": "isLoaderOptions",
            "desc": "Returns true if the argument is a valid set of loader options",
            "params": [
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "any?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 60,
                "path": "src/loader/src/LoaderOptionUtils.lua"
            }
        },
        {
            "name": "createOptions",
            "desc": "Fills in whatever the caller left out.",
            "params": [
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "PartialLoaderOptions?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "LoaderOptions"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 90,
                "path": "src/loader/src/LoaderOptionUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "LoaderOptionUtils",
    "desc": "Options controlling how the loader bootstraps.",
    "source": {
        "line": 7,
        "path": "src/loader/src/LoaderOptionUtils.lua"
    }
}