@empathyco/x-components/docs/API-reference/api/x-components.addquerytohistory.md

Empathy X Components

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

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [addQueryToHistory](./x-components.addquerytohistory.md)

## addQueryToHistory() function

Default implementation for the [HistoryQueriesActions.addQueryToHistory](./x-components.historyqueriesactions.addquerytohistory.md)<!-- -->.

**Signature:**

```typescript
addQueryToHistory: ({ state, dispatch }: HistoryQueriesActionContext, query: string) => void | Promise<void>
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

{ state, dispatch }


</td><td>

[HistoryQueriesActionContext](./x-components.historyqueriesactioncontext.md)


</td><td>


</td></tr>
<tr><td>

query


</td><td>

string


</td><td>

The query to try to add to the history.


</td></tr>
</tbody></table>

**Returns:**

void \| Promise&lt;void&gt;

A `void` promise that resolves when the history queries finishes updating.