search-client/es/Find/FindSettings.d.ts

Javascript library for executing searches in the Haive search-index via the SearchManager REST interface.

import { BaseSettings, IBaseSettings } from '../Common';
import { IMatches } from '../Data';
import { FindTriggers } from './FindTriggers';
export interface IFindSettings extends IBaseSettings<IMatches> {
    /**
     * The trigger-settings for when automatic match result-updates are to be triggered.
     */
    triggers?: FindTriggers;
}
/**
 * These are all the settings that can affect the returned categories for Find() lookups.
 */
export declare class FindSettings extends BaseSettings<IMatches> {
    /**
     * The trigger-settings for when automatic match result-updates are to be triggered.
     */
    triggers: FindTriggers;
    /**
     * The endpoint to do Find lookups for. Overrides base-class.
     * Default: "search/find"
     */
    servicePath: string;
    /**
     * Creates a FindSettings object for you, based on FindSettings defaults and the overrides provided as a param.
     * @param settings - The settings defined here will override the default FindSettings.
     */
    constructor(settings: IFindSettings | string);
}