<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@essex/toolbox](./toolbox.md) &gt; [throttle](./toolbox.throttle.md)

## throttle() function

Debounces function based on options provided

<b>Signature:</b>

```typescript
export declare function throttle(func: (...args: any[]) => any, wait?: number, options?: ThrottleOptions): any;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  func | (...args: any\[\]) =&gt; any | function to throttle |
|  wait | number | <i>(Optional)</i> time in milliseconds |
|  options | [ThrottleOptions](./toolbox.throttleoptions.md) | <i>(Optional)</i> optional object param to control timing, ex. {<!-- -->trailing: false, leading: true<!-- -->} |

<b>Returns:</b>

any

