@empathyco/x-components
Version:
Empathy X Components
42 lines • 1.07 kB
TypeScript
/**
* Configuration options for the {@link NextQueriesXModule}.
*
* @public
*/
export interface NextQueriesConfig {
/**
* Number of next queries that will be requested.
*/
maxItemsToRequest: number;
/**
* Hides the next queries if it has been already searched during the session.
*
* @example
* When set to true:
* ```
* query = 'shorts';
* query = 'trousers';
* suggestions = ['t-shirt', 'shorts', 'dress']
* // Suggests ['t-shirt', 'dress']
* ```
*
* @example
* When set to false:
* ```
* query = 'shorts';
* query = 'trousers';
* suggestions = ['t-shirt', 'shorts', 'dress']
* // Suggests ['t-shirt', 'shorts', 'dress']
* ```
*/
hideSessionQueries: boolean;
/**
* Loads the next queries with the last searched query.
*/
loadOnInit: boolean;
/**
* Number of results that will be requested to preview the next queries.
*/
maxPreviewItemsToRequest: number;
}
//# sourceMappingURL=config.types.d.ts.map