Skip to main content

promiseChild

Warps the WaitForChild API with a promise

Functions

promiseChild

promiseChild.promiseChild(
parentInstance,
namestring,
timeOutnumber?
) → Promise<Instance>

Wraps the :WaitForChild API with a promise

Show raw api
{
    "functions": [
        {
            "name": "promiseChild",
            "desc": "Wraps the :WaitForChild API with a promise",
            "params": [
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "timeOut",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Instance>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/promise/src/Shared/Utility/promiseChild.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "promiseChild",
    "desc": "Warps the WaitForChild API with a promise",
    "source": {
        "line": 5,
        "path": "src/promise/src/Shared/Utility/promiseChild.lua"
    }
}