Skip to main content

promisePropertyValue

Promises a property value

Functions​

promisePropertyValue​

</>
promisePropertyValue.promisePropertyValue(
instance: Instance,
propertyName: string
) → Promise<Instance>

Promise that resolves when the property value is truthy.

warning

To use properly please make sure to reject the promise for proper GC if the object requiring

Show raw api
{
    "functions": [
        {
            "name": "promisePropertyValue",
            "desc": "Promise that resolves when the property value is truthy.\n\n:::warning\nTo use properly please make sure to reject the promise for proper GC if the object requiring\n:::",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "propertyName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Instance>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/promise/src/Shared/Utility/promisePropertyValue.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "promisePropertyValue",
    "desc": "Promises a property value",
    "source": {
        "line": 5,
        "path": "src/promise/src/Shared/Utility/promisePropertyValue.lua"
    }
}