@coveo/headless
    Preparing search index...

    Interface SearchParameters

    The parameters affecting the search response.

    interface SearchParameters {
        af?: Record<string, string[]>;
        aq?: string;
        cf?: Record<string, string[]>;
        cq?: string;
        debug?: boolean;
        df?: Record<string, DateRangeRequest[]>;
        enableQuerySyntax?: boolean;
        f?: Record<string, string[]>;
        fExcluded?: Record<string, string[]>;
        firstResult?: number;
        mnf?: Record<string, NumericRangeRequest>;
        nf?: Record<string, NumericRangeRequest[]>;
        numberOfResults?: number;
        q?: string;
        sf?: Record<string, string[]>;
        sortCriteria?: string;
        tab?: string;
    }
    Index

    Properties

    af? aq? cf? cq? debug? df? enableQuerySyntax? f? fExcluded? firstResult? mnf? nf? numberOfResults? q? sf? sortCriteria? tab?

    Properties

    af?: Record<string, string[]>

    A record of the automatic facets, where the key is the facet id, and value is an array containing the selected values.

    aq?: string

    The advanced query expression.

    cf?: Record<string, string[]>

    A record of the category facets, where the key is the facet id, and value is an array containing the parts of the selected path.

    cq?: string

    The constant query expression.

    debug?: boolean

    Determines whether to return debug information for a query.

    df?: Record<string, DateRangeRequest[]>

    A record of the date facets, where the key is the facet id, and value is an array containing the date ranges to request.

    enableQuerySyntax?: boolean

    Whether to interpret advanced Coveo Cloud query syntax in the query.

    f?: Record<string, string[]>

    A record of the facets, where the key is the facet id, and value is an array containing the selected values.

    fExcluded?: Record<string, string[]>

    A record of the excluded facets, where the key is the facet id, and value is an array containing the excluded values.

    firstResult?: number

    A zero-based index of the first result.

    mnf?: Record<string, NumericRangeRequest>

    A record of the manual numeric facets, where the key is the facet id, and the value is the selected numeric range.

    nf?: Record<string, NumericRangeRequest[]>

    A record of the numeric facets, where the key is the facet id, and value is an array containing the numeric ranges to request.

    numberOfResults?: number

    The number of results to return.

    q?: string

    The query.

    sf?: Record<string, string[]>

    A record of the static filters, where the key is the static filter id, and value is an array containing the selected static filter captions.

    sortCriteria?: string

    The sort expression to order returned results by.

    tab?: string

    The active tab id.

    Restoring the tab with the restoreSearchParameters action can cause components to be visible/hidden on the wrong tab. Instead, first restore the tab using the restoreTab action, then the rest of the parameters with the restoreSearchParameters action.

    Settings

    Member Visibility

    On This Page

    Properties