[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [UseAliasAPI](./x-components.usealiasapi.md) ## UseAliasAPI interface Alias to facilitate retrieving values from the store. **Signature:** ```typescript export interface UseAliasAPI ``` ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [device](./x-components.usealiasapi.device.md) | readonly | string \| null | The [DeviceXModule](./x-components.devicexmodule.md) detected device. | | [facets](./x-components.usealiasapi.facets.md) | readonly | Record<Facet\['id'\], Facet> | The [FacetsXModule](./x-components.facetsxmodule.md) facets. | | [fromNoResultsWithFilters](./x-components.usealiasapi.fromnoresultswithfilters.md) | readonly | Readonly<boolean> | The [SearchXModule](./x-components.searchxmodule.md) no results with filters flag. | | [fullHistoryQueries](./x-components.usealiasapi.fullhistoryqueries.md) | readonly | ReadonlyArray<HistoryQuery> | The [HistoryQueriesXModule](./x-components.historyqueriesxmodule.md) history queries. | | [fullQuerySuggestions](./x-components.usealiasapi.fullquerysuggestions.md) | readonly | ReadonlyArray<Suggestion> | The [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md) query suggestions. | | [historyQueries](./x-components.usealiasapi.historyqueries.md) | readonly | ReadonlyArray<HistoryQuery> | The [HistoryQueriesXModule](./x-components.historyqueriesxmodule.md) history queries matching the query. | | [historyQueriesWithResults](./x-components.usealiasapi.historyquerieswithresults.md) | readonly | ReadonlyArray<HistoryQuery> | The [HistoryQueriesXModule](./x-components.historyqueriesxmodule.md) history queries with 1 or more results. | | [identifierResults](./x-components.usealiasapi.identifierresults.md) | readonly | ReadonlyArray<Result> | The [IdentifierResultsXModule](./x-components.identifierresultsxmodule.md) results. | | [isEmpathizeOpen](./x-components.usealiasapi.isempathizeopen.md) | readonly | boolean | The [Empathize](./x-components.empathize.md) is open state. | | [isHistoryQueriesEnabled](./x-components.usealiasapi.ishistoryqueriesenabled.md) | readonly | Readonly<boolean> | The [HistoryQueriesXModule](./x-components.historyqueriesxmodule.md) history queries enabled flag. | | [nextQueries](./x-components.usealiasapi.nextqueries.md) | readonly | ReadonlyArray<NextQuery> | The [NextQueriesXModule](./x-components.nextqueriesxmodule.md) next queries. | | [noResults](./x-components.usealiasapi.noresults.md) | readonly | boolean | The [SearchXModule](./x-components.searchxmodule.md) no results situation. | | [partialResults](./x-components.usealiasapi.partialresults.md) | readonly | ReadonlyArray<PartialResult> | The [SearchXModule](./x-components.searchxmodule.md) partial results. | | [popularSearches](./x-components.usealiasapi.popularsearches.md) | readonly | ReadonlyArray<Suggestion> | The [PopularSearchesXModule](./x-components.popularsearchesxmodule.md) popular searches. | | [priceStats](./x-components.usealiasapi.pricestats.md) | readonly | { min: number; max: number; } | The [SearchXModule](./x-components.searchxmodule.md) price specific stats. | | [query](./x-components.usealiasapi.query.md) | readonly | [UseAliasQueryAPI](./x-components.usealiasqueryapi.md) | The query value of the different modules. | | [querySuggestions](./x-components.usealiasapi.querysuggestions.md) | readonly | ReadonlyArray<Suggestion> | The [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md) query suggestions that should be displayed. | | [recommendations](./x-components.usealiasapi.recommendations.md) | readonly | ReadonlyArray<Result> | The [RecommendationsXModule](./x-components.recommendationsxmodule.md) recommendations. | | [redirections](./x-components.usealiasapi.redirections.md) | readonly | ReadonlyArray<Redirection> | The [SearchXModule](./x-components.searchxmodule.md) redirections. | | [relatedTags](./x-components.usealiasapi.relatedtags.md) | readonly | ReadonlyArray<RelatedTag> | The [RelatedTagsXModule](./x-components.relatedtagsxmodule.md) related tags (Both selected and deselected). | | [results](./x-components.usealiasapi.results.md) | readonly | ReadonlyArray<Result> | The [SearchXModule](./x-components.searchxmodule.md) search results. | | [scroll](./x-components.usealiasapi.scroll.md) | readonly | Record<string, [ScrollComponentState](./x-components.scrollcomponentstate.md)> | The [ScrollXModule](./x-components.scrollxmodule.md) data state. | | [searchBoxStatus](./x-components.usealiasapi.searchboxstatus.md) | readonly | InputStatus \| undefined | The [SearchBoxXModule](./x-components.searchboxxmodule.md) input status. | | [selectedFilters](./x-components.usealiasapi.selectedfilters.md) | readonly | Filter\[\] | The [FacetsXModule](./x-components.facetsxmodule.md) selected filters. | | [selectedRelatedTags](./x-components.usealiasapi.selectedrelatedtags.md) | readonly | ReadonlyArray<RelatedTag> | The [RelatedTagsXModule](./x-components.relatedtagsxmodule.md) selected related tags. | | [selectedSort](./x-components.usealiasapi.selectedsort.md) | readonly | string | The [SearchXModule](./x-components.searchxmodule.md) selected sort. | | [semanticQueries](./x-components.usealiasapi.semanticqueries.md) | readonly | ReadonlyArray<SemanticQuery> | The [SemanticQueriesXModule](./x-components.semanticqueriesxmodule.md) queries. | | [spellcheckedQuery](./x-components.usealiasapi.spellcheckedquery.md) | readonly | string \| null | The [SearchXModule](./x-components.searchxmodule.md) spellchecked query. | | [status](./x-components.usealiasapi.status.md) | readonly | [UseAliasStatusAPI](./x-components.usealiasstatusapi.md) | The status value of the different modules. | | [totalResults](./x-components.usealiasapi.totalresults.md) | readonly | number | The [SearchXModule](./x-components.searchxmodule.md) total results. |