Skip to main content

ObservableMapList

Holds a map of lists. This is good for list-based

Functions​

new​

</>
ObservableMapList.new() → ObservableMapList<TKey,TValue>

Constructs a new ObservableMapList

Push​

</>
ObservableMapList:Push(
observeKey: Observable<TKey>,
entry: TValue
) → MaidTask--

Cleanup object that will remove the entry

Adds an entry with a dynamic key. This is great for caching things that need to be looked up by key.

tip

If observeKey emits nil then the value will be excluded from the list.

GetListCount​

</>
ObservableMapList:GetListCount() → number

Gets how many lists exist

ObserveListCount​

</>
ObservableMapList:ObserveListCount() → Observable<number>

Observes how many lists exist

GetAtListIndex​

</>
ObservableMapList:GetAtListIndex(
key: TKey,
index: number
) → Observable<TValue?>

Gets the current value at the list index

ObserveAtListIndex​

</>
ObservableMapList:ObserveAtListIndex(
key: TKey,
index: number
) → Observable<TValue?>

Observes the current value at the index

GetKeyList​

</>
ObservableMapList:GetKeyList() → {TKey}

Gets a list of all keys

ObserveKeyList​

</>
ObservableMapList:ObserveKeyList() → Observable<{TKey}>

Observes the list of all keys.

ObserveKeysBrio​

</>
ObservableMapList:ObserveKeysBrio() → Observable<Brio<TKey>>

Observes all keys in the map

ObserveAtListIndexBrio​

</>
ObservableMapList:ObserveAtListIndexBrio(
key: TKey,
index: number
) → Observable<Brio<TValue>>

Observes the current value at the index

ObserveItemsForKeyBrio​

</>
ObservableMapList:ObserveItemsForKeyBrio(key: TKey) → Observable<Brio<TValue>>

Observes all items at the given key

GetListFromKey​

</>
ObservableMapList:GetListFromKey(key: TKey) → {TValue}

Gets a list for a given key.

GetListForKey​

</>
ObservableMapList:GetListForKey(key: TKey) → ObservableList<TValue>

Gets the observable list for the given key

Destroy​

</>
ObservableMapList:Destroy() → ()

Cleans up the ObservableMapList and sets the metatable to nil.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new ObservableMapList",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ObservableMapList<TKey, TValue>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "Push",
            "desc": "Adds an entry with a dynamic key. This is great for caching things\nthat need to be looked up by key.\n\n:::tip\nIf `observeKey` emits nil then the value will be excluded from the list.\n:::",
            "params": [
                {
                    "name": "observeKey",
                    "desc": "",
                    "lua_type": "Observable<TKey>"
                },
                {
                    "name": "entry",
                    "desc": "",
                    "lua_type": "TValue"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup object that will remove the entry",
                    "lua_type": "MaidTask"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 45,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "GetListCount",
            "desc": "Gets how many lists exist",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 76,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "ObserveListCount",
            "desc": "Observes how many lists exist",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 84,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "GetAtListIndex",
            "desc": "Gets the current value at the list index",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "TKey"
                },
                {
                    "name": "index",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<TValue?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 95,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "ObserveAtListIndex",
            "desc": "Observes the current value at the index",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "TKey"
                },
                {
                    "name": "index",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<TValue?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 114,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "GetKeyList",
            "desc": "Gets a list of all keys",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ TKey }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 134,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "ObserveKeyList",
            "desc": "Observes the list of all keys.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<{ TKey }>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 142,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "ObserveKeysBrio",
            "desc": "Observes all keys in the map",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<TKey>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 150,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "ObserveAtListIndexBrio",
            "desc": "Observes the current value at the index",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "TKey"
                },
                {
                    "name": "index",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<TValue>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 161,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "ObserveItemsForKeyBrio",
            "desc": "Observes all items at the given key",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "TKey"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<TValue>>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 182,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "GetListFromKey",
            "desc": "Gets a list for a given key.",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "TKey"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ TValue }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 202,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "GetListForKey",
            "desc": "Gets the observable list for the given key",
            "params": [
                {
                    "name": "key",
                    "desc": "",
                    "lua_type": "TKey"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ObservableList<TValue>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 218,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the ObservableMapList and sets the metatable to nil.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 280,
                "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ObservableMapList",
    "desc": "Holds a map of lists. This is good for list-based",
    "source": {
        "line": 6,
        "path": "src/observablecollection/src/Shared/ObservableMapList.lua"
    }
}