@klevu/core/dist/cjs/queries/search/search.d.ts

Typescript SDK that simplifies development on Klevu backend. Klevu provides advanced AI-powered search and discovery solutions for online retailers.

import { KlevuFetchFunctionReturnValue } from "../index.js";
import { KlevuBaseQuerySettings } from "../../models/KlevuBaseQuerySettings.js";
import { KlevuAnyTypeOfRecord } from "../../models/index.js";
import { KlevuFetchModifer } from "../../modifiers/index.js";
/**
 * Search options to modify the search query.
 */
export type KlevuSearchOptions = {
    id: string;
    /**
     * The type of records to search for.
     */
    typeOfRecords: KlevuAnyTypeOfRecord[];
} & Omit<KlevuBaseQuerySettings, "query">;
/**
 * Create a basic search to Klevu backend. Default ID for this query is `search`
 *
 *
 * @category Query
 * @param term Search term from input
 * @param options {@link KlevuSearchOptions}
 * @returns
 */
export declare function search(term: string, options?: Partial<KlevuSearchOptions>, ...modifiers: KlevuFetchModifer[]): KlevuFetchFunctionReturnValue;