@lableb/javascript-sdk/dist/types/request/autocomplete/autocomplete.request.type.d.ts

Lableb cloud search client for javascript

import { BaseRequestParams, BuildRequestResult } from '../../types';
export interface AutocompleteRequestParams extends BaseRequestParams {
    /**
     * your autocomplete API Key copied from [Lableb Dashboard](https://dashboard.lableb.com)
     */
    APIKey?: string;
    /** the used autocomplete handler for the autocomplete function */
    autocompleteHandler?: string;
    /** usually your end users query */
    query: string;
    /** limit your autocomplete results to some number */
    limit?: number;
    /**
     * You type the field name followed by the `asc` or `desc` to sort data by that field in an ascending or   descending order respectively.
     *
     * ```js
     * sort: "date desc"
     * ```
     */
    sort?: string;
}
export interface AutocompleteRequestResult extends BuildRequestResult {
    params: Omit<AutocompleteRequestParams, "platformName" | "APIKey" | "indexName" | "autocompleteHandler" | "query"> & {
        q: string;
        apikey?: string;
    };
}