Skip to main content

debounce

debounce a existing function by timeout

Functions​

debounce​

</>
debounce.debounce(
timeoutInSeconds: number,
func: function
) → (...) → ()

Provides a debounce function call on an operation

Show raw api
{
    "functions": [
        {
            "name": "debounce",
            "desc": "Provides a debounce function call on an operation",
            "params": [
                {
                    "name": "timeoutInSeconds",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "func",
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(...) -> ()"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 15,
                "path": "src/debounce/src/Shared/debounce.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "debounce",
    "desc": "debounce a existing function by timeout",
    "source": {
        "line": 5,
        "path": "src/debounce/src/Shared/debounce.lua"
    }
}