@rbxts/pretty-react-hooks/out/use-throttle-callback/README.md

Useful hooks for @rbxts/react

## 🪝 `useThrottleCallback`

```ts
function useThrottleCallback<T extends Callback>(callback: T, options?: UseThrottleOptions): UseDebounceResult<T>;
```

Creates a throttled function that only invokes `callback` at most once per every `wait` seconds.

The callback is invoked with the last arguments provided to the throttled function. Subsequent calls to the throttled function return the result of the last `callback` invocation.

See [lodash.throttle](https://lodash.com/docs/4.17.15#throttle) for the function this hook is based on.

### 📕 Parameters

-   `callback` - The function to throttle.
-   `options` - The options object.
    -   `wait` - The number of seconds to throttle. Defaults to `0`.
    -   `leading` - Specify invoking on the leading edge of the timeout. Defaults to `true`.
    -   `trailing` - Specify invoking on the trailing edge of the timeout. Defaults to `true`.

### 📗 Returns

-   A `UseDebounceResult` object.
    -   `run` - The throttled function.
    -   `cancel` - Cancels any pending invocation.
    -   `flush` - Immediately invokes a pending invocation.
    -   `pending` - Whether there is a pending invocation.

### 📘 Example

Throttle viewport size updates to once per second.

```tsx
function ViewportProvider() {
	const camera = useCamera();
	const [viewport, setViewport] = useState(camera.ViewportSize);

	const throttled = useThrottleCallback((size: Vector2) => {
		setViewport(size);
	}, 1);

	useEventListener(camera.GetPropertyChangedSignal("ViewportSize"), () => {
		throttled.run(camera.ViewportSize);
	});

	return <Viewport.Provider value={viewport} />;
}
```