Skip to main content

ListIndexUtils

Functions​

toPositiveIndex​

</>
ListIndexUtils.toPositiveIndex(
listLength: number,
index: number
) → number

Converts a negative index to a positive one for the list indexing

toNegativeIndex​

</>
ListIndexUtils.toNegativeIndex(
listLength: number,
index: number
) → number

Converts a positive index to a negative one for list indexing

Show raw api
{
    "functions": [
        {
            "name": "toPositiveIndex",
            "desc": "Converts a negative index to a positive one for the list indexing",
            "params": [
                {
                    "name": "listLength",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "index",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 12,
                "path": "src/observablecollection/src/Shared/Utils/ListIndexUtils.lua"
            }
        },
        {
            "name": "toNegativeIndex",
            "desc": "Converts a positive index to a negative one for list indexing",
            "params": [
                {
                    "name": "listLength",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "index",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 28,
                "path": "src/observablecollection/src/Shared/Utils/ListIndexUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ListIndexUtils",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/observablecollection/src/Shared/Utils/ListIndexUtils.lua"
    }
}