Skip to main content

promiseBoundClass

Utility function to promise a bound class on an object

Functions​

promiseBoundClass​

</>
promiseBoundClass.promiseBoundClass(
binder: Binder<T>,
inst: Instance,
cancelToken: CancelToken
) → Promise<T>

Returns a promise that resolves when the class is bound to the instance.

Show raw api
{
    "functions": [
        {
            "name": "promiseBoundClass",
            "desc": "Returns a promise that resolves when the class is bound to the instance.",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<T>"
                },
                {
                    "name": "inst",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "cancelToken",
                    "desc": "",
                    "lua_type": "CancelToken"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/binder/src/Shared/Promise/promiseBoundClass.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "promiseBoundClass",
    "desc": "Utility function to promise a bound class on an object",
    "source": {
        "line": 5,
        "path": "src/binder/src/Shared/Promise/promiseBoundClass.lua"
    }
}