Interface NostoClient

interface NostoClient {
    placements: {
        getPlacements(): string[];
        injectCampaigns(recommendations: Record<string, Recommendation>): void;
    };
    captureError(error: unknown, reporter: string, level: LogLevel): void;
    defaultSession(): NostoSession;
    recordSearchClick(type: "autocomplete" | "category" | "serp", hit: {
        keyword?: string;
        url?: string;
    }): void;
    recordSearchSubmit(query: string): void;
    search(query: InputSearchQueryWithFields, options?: SearchOptions): PromiseLike<SearchResult>;
    setAutoLoad(autoload: boolean): NostoClient;
}

Properties

placements

Methods

captureError defaultSession recordSearchClick recordSearchSubmit search setAutoLoad

Properties

placements

placements: {
    getPlacements(): string[];
    injectCampaigns(recommendations: Record<string, Recommendation>): void;
}

Methods

captureError

  • captureError(error, reporter, level): void

  • Parameters

    • error: unknown
    • reporter: string
    • level: LogLevel

    Returns void

defaultSession

recordSearchClick

  • recordSearchClick(type, hit): void

  • Parameters

    • type: "autocomplete" | "category" | "serp"
    • hit: {
          keyword?: string;
          url?: string;
      }
      • Optionalkeyword?: string
      • Optionalurl?: string

    Returns void

recordSearchSubmit

  • recordSearchSubmit(query): void

  • Parameters

    • query: string

    Returns void

search

setAutoLoad

Settings

Member Visibility

On This Page

Properties
Methods