Skip to main content

types

Just a types module.

Types​

Service​

</>
type Service = {[string | unknown]: unknown}

InjectedAPI​

</>
interface InjectedAPI {
addModule: (module: ModuleScript) → ()
}

This is the type which gets injected into _G. This allows packages to just be loaded with Sapling.loadPackages without manually calling require on every single pacakge you use in your game.

Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "Service",
            "desc": "",
            "lua_type": "{ [string | unknown]: unknown }",
            "source": {
                "line": 10,
                "path": "packages/sapling/source/types.luau"
            }
        },
        {
            "name": "InjectedAPI",
            "desc": "This is the type which gets injected into `_G`. This allows packages to just be loaded with [Sapling.loadPackages] without manually\ncalling `require` on every single pacakge you use in your game.",
            "fields": [
                {
                    "name": "addModule",
                    "lua_type": "(module: ModuleScript) -> ()",
                    "desc": ""
                }
            ],
            "source": {
                "line": 20,
                "path": "packages/sapling/source/types.luau"
            }
        }
    ],
    "name": "types",
    "desc": "Just a types module.",
    "source": {
        "line": 5,
        "path": "packages/sapling/source/types.luau"
    }
}