Skip to main content

SortedNodeValue

Simplifies comparison logic

Functions​

new​

</>
SortedNodeValue.new(
value: T,
compare: (
a: T,
b: T
) → number
) → SortedNodeValue

Constructs a new SortedNodeValue

GetValue​

</>
SortedNodeValue.GetValue(self: SortedNodeValue<T>) → T

Returns the value of the SortedNodeValue

isSortedNodeValue​

</>
SortedNodeValue.isSortedNodeValue(value: any) → boolean

Returns whether or not a value is a SortedNodeValue

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new SortedNodeValue",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "T"
                },
                {
                    "name": "compare",
                    "desc": "",
                    "lua_type": "(a: T, b: T) -> number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SortedNodeValue"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "src/observablecollection/src/Shared/SortedList/SortedNodeValue.lua"
            }
        },
        {
            "name": "GetValue",
            "desc": "Returns the value of the SortedNodeValue",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SortedNodeValue<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 46,
                "path": "src/observablecollection/src/Shared/SortedList/SortedNodeValue.lua"
            }
        },
        {
            "name": "isSortedNodeValue",
            "desc": "Returns whether or not a value is a SortedNodeValue",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/observablecollection/src/Shared/SortedList/SortedNodeValue.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SortedNodeValue",
    "desc": "Simplifies comparison logic",
    "source": {
        "line": 7,
        "path": "src/observablecollection/src/Shared/SortedList/SortedNodeValue.lua"
    }
}