Skip to main content

throttle

Debounce a existing function by timeout

Functions​

throttle​

</>
throttle.throttle(
timeoutInSeconds: number,
func: function,
throttleConfig?: {leading=true;trailing=true;}
) → function

Provides a debounce function call on an operation.

Show raw api
{
    "functions": [
        {
            "name": "throttle",
            "desc": "Provides a debounce function call on an operation.",
            "params": [
                {
                    "name": "timeoutInSeconds",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "func",
                    "desc": "",
                    "lua_type": "function"
                },
                {
                    "name": "throttleConfig?",
                    "desc": "",
                    "lua_type": "{ leading = true; trailing = true; }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/throttle/src/Shared/throttle.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "throttle",
    "desc": "Debounce a existing function by timeout",
    "source": {
        "line": 6,
        "path": "src/throttle/src/Shared/throttle.lua"
    }
}