Skip to main content

Types

All types used by Toasty

Types​

Singleton​

</>
interface Singleton {
Implements: {string}
Dependencies: {Singleton}
LoadOrder: number
}

SingletonOptions​

</>
interface SingletonOptions {
Implements: {string}?
Dependencies: {Singleton}?
LoadOrder: number?
}

LifecycleHandler​

</>
type LifecycleHandler = (
singletons: {Singleton},
name: string,
...any
) → ()

Marker​

</>
type Marker = {}

MiddlewareFn​

since v1.1.0
</>
type MiddlewareFn = (
deny: Marker,
next: Marker,
args: {[number]: any}
) → Marker

The Args table is the Args that are passed to the event callback. Any modifications to these are retained to the next middleware and eventually to the callback.

Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "Singleton",
            "desc": "",
            "fields": [
                {
                    "name": "Implements",
                    "lua_type": "{ string }",
                    "desc": ""
                },
                {
                    "name": "Dependencies",
                    "lua_type": "{ Singleton }",
                    "desc": ""
                },
                {
                    "name": "LoadOrder",
                    "lua_type": "number",
                    "desc": ""
                }
            ],
            "source": {
                "line": 13,
                "path": "Source/Core/Types.luau"
            }
        },
        {
            "name": "SingletonOptions",
            "desc": "",
            "fields": [
                {
                    "name": "Implements",
                    "lua_type": "{ string }?",
                    "desc": ""
                },
                {
                    "name": "Dependencies",
                    "lua_type": "{ Singleton }?",
                    "desc": ""
                },
                {
                    "name": "LoadOrder",
                    "lua_type": "number?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 26,
                "path": "Source/Core/Types.luau"
            }
        },
        {
            "name": "LifecycleHandler",
            "desc": "",
            "lua_type": "(singletons: { Singleton }, name: string, ...any) -> ()",
            "source": {
                "line": 36,
                "path": "Source/Core/Types.luau"
            }
        },
        {
            "name": "Marker",
            "desc": "",
            "lua_type": "{}",
            "source": {
                "line": 49,
                "path": "Source/Core/Types.luau"
            }
        },
        {
            "name": "MiddlewareFn",
            "desc": "The Args table is the Args that are passed to the event callback. Any modifications to these\nare retained to the next middleware and eventually to the callback.",
            "lua_type": "(deny: Marker, next: Marker, args: {[number]: any}) -> Marker",
            "since": "v1.1.0",
            "source": {
                "line": 58,
                "path": "Source/Core/Types.luau"
            }
        }
    ],
    "name": "Types",
    "desc": "All types used by Toasty",
    "source": {
        "line": 5,
        "path": "Source/Core/Types.luau"
    }
}