IHybridSearchResult
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Result of the useHybridSearch hook.
export interface IHybridSearchResult<I extends SearchItem, G extends SearchItemGroup<I>>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) | |||
(props: { items: ReadonlyArray<I>; allItems?: ReadonlyArray<I>; itemGroups?: ReadonlyArray<G>; keywords?: string[]; }) => ICombinedSearchResults<I, G> | (ALPHA) | ||
(ALPHA) | |||
(ALPHA) |
Property details
IHybridSearchResult.onSearchQueryChangepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
onSearchQueryChange: OnSearchQueryChanged;
IHybridSearchResult.searchpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
search: (props: {
items: ReadonlyArray<I>;
allItems?: ReadonlyArray<I>;
itemGroups?: ReadonlyArray<G>;
keywords?: string[];
}) => ICombinedSearchResults<I, G>;
IHybridSearchResult.searchStatepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
searchState: ISearchState;
IHybridSearchResult.semanticSearchStatepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
semanticSearchState: ISemanticSearchState;