# debounceEvent

If you have an event definition tied to a Redux action that fires too frequently, you can use this util to limit the frequency of analytics events (e.g. form input).

## Import

```javascript
import debounceEvent from '@redux-beacon/debounce-event';
```

## Syntax

```javascript
debounceEvent(msDelay, eventDef)
```

### Parameters

* `msDelay`: [`number`](https://developer.mozilla.org/en-US/docs/Glossary/Number)
  * The time in milliseconds that needs to elapse between event definition calls

    before the analytics event is dispatched to a target.
* `eventDef`: [`EventDefinition`](/redux-beacon/index-1/event-definition.md)
  * The event you want to debounce.

## Example

```javascript
import debounceEvent from '@redux-beacon/debounce-event';

// A normal event definition
const searchTerm = (action) => ({
  hitType: 'event',
  eventCategory: 'books',
  eventAction: 'search',
  eventLabel: action.payload
});

const eventsMap = {
  // Assume that SEARCH_TERM_ENTERED fires whenever a user types a character into
  // an input field.
  SEARCH_TERM_ENTERED: debounceEvent(1000, searchTerm)
  // The analytics event will only fire after 1s since the last entered character
};

// provide the events map when creating your middleware or meta reducer...
```


---

# 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://rangle.gitbook.io/redux-beacon/index-3/debounce-event.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.
