Skip to main content

ValueObjectUtils

Utils that work with Roblox Value objects (and also ValueObject)

Functions​

syncValue​

</>
ValueObjectUtils.syncValue(
from: ValueObject<T>,
to: ValueObject<T>
) → MaidTask

Syncs the value from from to to.

observeValue​

</>
ValueObjectUtils.observeValue(valueObject: ValueObject<T>) → Observable<T>

Observes the current value of the ValueObject

observeValueBrio​

</>
ValueObjectUtils.observeValueBrio(valueObject: ValueObject<T>) → Observable<Brio<T>>

Observes the current value of the ValueObject

Show raw api
{
    "functions": [
        {
            "name": "syncValue",
            "desc": "Syncs the value from `from` to `to`.",
            "params": [
                {
                    "name": "from",
                    "desc": "",
                    "lua_type": "ValueObject<T>"
                },
                {
                    "name": "to",
                    "desc": "",
                    "lua_type": "ValueObject<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MaidTask"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/valueobject/src/Shared/ValueObjectUtils.lua"
            }
        },
        {
            "name": "observeValue",
            "desc": "Observes the current value of the ValueObject",
            "params": [
                {
                    "name": "valueObject",
                    "desc": "",
                    "lua_type": "ValueObject<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 37,
                "path": "src/valueobject/src/Shared/ValueObjectUtils.lua"
            }
        },
        {
            "name": "observeValueBrio",
            "desc": "Observes the current value of the ValueObject",
            "params": [
                {
                    "name": "valueObject",
                    "desc": "",
                    "lua_type": "ValueObject<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<T>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 48,
                "path": "src/valueobject/src/Shared/ValueObjectUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ValueObjectUtils",
    "desc": "Utils that work with Roblox Value objects (and also ValueObject)",
    "source": {
        "line": 5,
        "path": "src/valueobject/src/Shared/ValueObjectUtils.lua"
    }
}