# use-debounce-state

### Module

```javascript
import { useDebounceState } from "@atomico/hooks/use-debounce-state";
```

### Syntax

this hook is similar to useState, but the purpose of this hook is to bottleneck the state at update time

```javascript
const [state, setState] = useDebounceState(
    delay:number, 
    initialState: any,
    mode?: "fps" | "timeout" | "idle"
);
```

**mode differences**

1. **fps**: 
   1. if delay is set to 1, the update is executed for each cycle of requestAnimationFrame(60fps),   
   2. if delay is defined as 2, the update is executed for every 2 cycle of requestAnimationFrame(30fps)
2. **timeout**: the delay will be the milliseconds for setTimeout
3. **idle** : the delay will be the milliseconds for requestIdleCallback

### Example

{% embed url="<https://webcomponents.dev/edit/collection/n2tZyzx4LMKqk1jNE0e9/0LxJOPQzUkiwU0TB8o2s/src/index.jsx>" %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://atomico.gitbook.io/doc/packages/atomico-hooks/use-debounce-state.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.