@empathyco/x-components/docs/API-reference/api/x-components.usealiasapi.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; [UseAliasAPI](./x-components.usealiasapi.md)

## UseAliasAPI interface

Alias to facilitate retrieving values from the store.

**Signature:**

```typescript
export interface UseAliasAPI 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[device](./x-components.usealiasapi.device.md)


</td><td>

`readonly`


</td><td>

string \| null


</td><td>

The [DeviceXModule](./x-components.devicexmodule.md) detected device.


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

[facets](./x-components.usealiasapi.facets.md)


</td><td>

`readonly`


</td><td>

Record&lt;Facet\['id'\], Facet&gt;


</td><td>

The [FacetsXModule](./x-components.facetsxmodule.md) facets.


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

[fromNoResultsWithFilters](./x-components.usealiasapi.fromnoresultswithfilters.md)


</td><td>

`readonly`


</td><td>

Readonly&lt;boolean&gt;


</td><td>

The [SearchXModule](./x-components.searchxmodule.md) no results with filters flag.


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

[fullHistoryQueries](./x-components.usealiasapi.fullhistoryqueries.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;HistoryQuery&gt;


</td><td>

The [HistoryQueriesXModule](./x-components.historyqueriesxmodule.md) history queries.


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

[fullQuerySuggestions](./x-components.usealiasapi.fullquerysuggestions.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;Suggestion&gt;


</td><td>

The [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md) query suggestions.


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

[historyQueries](./x-components.usealiasapi.historyqueries.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;HistoryQuery&gt;


</td><td>

The [HistoryQueriesXModule](./x-components.historyqueriesxmodule.md) history queries matching the query.


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

[historyQueriesWithResults](./x-components.usealiasapi.historyquerieswithresults.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;HistoryQuery&gt;


</td><td>

The [HistoryQueriesXModule](./x-components.historyqueriesxmodule.md) history queries with 1 or more results.


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

[identifierResults](./x-components.usealiasapi.identifierresults.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;Result&gt;


</td><td>

The [IdentifierResultsXModule](./x-components.identifierresultsxmodule.md) results.


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

[isEmpathizeOpen](./x-components.usealiasapi.isempathizeopen.md)


</td><td>

`readonly`


</td><td>

boolean


</td><td>

The [Empathize](./x-components.empathize.md) is open state.


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

[isHistoryQueriesEnabled](./x-components.usealiasapi.ishistoryqueriesenabled.md)


</td><td>

`readonly`


</td><td>

Readonly&lt;boolean&gt;


</td><td>

The [HistoryQueriesXModule](./x-components.historyqueriesxmodule.md) history queries enabled flag.


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

[nextQueries](./x-components.usealiasapi.nextqueries.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;NextQuery&gt;


</td><td>

The [NextQueriesXModule](./x-components.nextqueriesxmodule.md) next queries.


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

[noResults](./x-components.usealiasapi.noresults.md)


</td><td>

`readonly`


</td><td>

boolean


</td><td>

The [SearchXModule](./x-components.searchxmodule.md) no results situation.


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

[partialResults](./x-components.usealiasapi.partialresults.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;PartialResult&gt;


</td><td>

The [SearchXModule](./x-components.searchxmodule.md) partial results.


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

[popularSearches](./x-components.usealiasapi.popularsearches.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;Suggestion&gt;


</td><td>

The [PopularSearchesXModule](./x-components.popularsearchesxmodule.md) popular searches.


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

[priceStats](./x-components.usealiasapi.pricestats.md)


</td><td>

`readonly`


</td><td>

{ min: number; max: number; }


</td><td>

The [SearchXModule](./x-components.searchxmodule.md) price specific stats.


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

[query](./x-components.usealiasapi.query.md)


</td><td>

`readonly`


</td><td>

[UseAliasQueryAPI](./x-components.usealiasqueryapi.md)


</td><td>

The query value of the different modules.


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

[querySuggestions](./x-components.usealiasapi.querysuggestions.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;Suggestion&gt;


</td><td>

The [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md) query suggestions that should be displayed.


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

[recommendations](./x-components.usealiasapi.recommendations.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;Result&gt;


</td><td>

The [RecommendationsXModule](./x-components.recommendationsxmodule.md) recommendations.


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

[redirections](./x-components.usealiasapi.redirections.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;Redirection&gt;


</td><td>

The [SearchXModule](./x-components.searchxmodule.md) redirections.


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

[relatedTags](./x-components.usealiasapi.relatedtags.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;RelatedTag&gt;


</td><td>

The [RelatedTagsXModule](./x-components.relatedtagsxmodule.md) related tags (Both selected and deselected).


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

[results](./x-components.usealiasapi.results.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;Result&gt;


</td><td>

The [SearchXModule](./x-components.searchxmodule.md) search results.


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

[scroll](./x-components.usealiasapi.scroll.md)


</td><td>

`readonly`


</td><td>

Record&lt;string, [ScrollComponentState](./x-components.scrollcomponentstate.md)<!-- -->&gt;


</td><td>

The [ScrollXModule](./x-components.scrollxmodule.md) data state.


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

[searchBoxStatus](./x-components.usealiasapi.searchboxstatus.md)


</td><td>

`readonly`


</td><td>

InputStatus \| undefined


</td><td>

The [SearchBoxXModule](./x-components.searchboxxmodule.md) input status.


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

[selectedFilters](./x-components.usealiasapi.selectedfilters.md)


</td><td>

`readonly`


</td><td>

Filter\[\]


</td><td>

The [FacetsXModule](./x-components.facetsxmodule.md) selected filters.


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

[selectedRelatedTags](./x-components.usealiasapi.selectedrelatedtags.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;RelatedTag&gt;


</td><td>

The [RelatedTagsXModule](./x-components.relatedtagsxmodule.md) selected related tags.


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

[selectedSort](./x-components.usealiasapi.selectedsort.md)


</td><td>

`readonly`


</td><td>

string


</td><td>

The [SearchXModule](./x-components.searchxmodule.md) selected sort.


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

[semanticQueries](./x-components.usealiasapi.semanticqueries.md)


</td><td>

`readonly`


</td><td>

ReadonlyArray&lt;SemanticQuery&gt;


</td><td>

The [SemanticQueriesXModule](./x-components.semanticqueriesxmodule.md) queries.


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

[spellcheckedQuery](./x-components.usealiasapi.spellcheckedquery.md)


</td><td>

`readonly`


</td><td>

string \| null


</td><td>

The [SearchXModule](./x-components.searchxmodule.md) spellchecked query.


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

[status](./x-components.usealiasapi.status.md)


</td><td>

`readonly`


</td><td>

[UseAliasStatusAPI](./x-components.usealiasstatusapi.md)


</td><td>

The status value of the different modules.


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

[totalResults](./x-components.usealiasapi.totalresults.md)


</td><td>

`readonly`


</td><td>

number


</td><td>

The [SearchXModule](./x-components.searchxmodule.md) total results.


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