Skip to main content
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new PropertyValue",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "propertyName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PropertyValue"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 50,
                "path": "src/propertyvalue/src/Shared/PropertyValue.lua"
            }
        },
        {
            "name": "ObserveBrio",
            "desc": "Observes the property of the object.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PropertyValue<T>"
                },
                {
                    "name": "condition",
                    "desc": "",
                    "lua_type": "Rx.Predicate<T>?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/propertyvalue/src/Shared/PropertyValue.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Observes the property of the object.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PropertyValue<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<any>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/propertyvalue/src/Shared/PropertyValue.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PropertyValue",
    "desc": "Proxies a property in Roblox",
    "source": {
        "line": 7,
        "path": "src/propertyvalue/src/Shared/PropertyValue.lua"
    }
}