import type { PayloadAction } from '@reduxjs/toolkit'; import type { SearchEngine } from '../../app/search-engine/search-engine.js'; import { type ClearExpiredInstantResultsActionCreatorPayload, type FetchInstantResultsActionCreatorPayload, type RegisterInstantResultActionCreatorPayload, type UpdateInstantResultQueryActionCreatorPayload } from './instant-results-actions.js'; export type { ClearExpiredInstantResultsActionCreatorPayload, FetchInstantResultsActionCreatorPayload, RegisterInstantResultActionCreatorPayload, UpdateInstantResultQueryActionCreatorPayload, }; /** * The instant results action creators. * * @group Actions * @category InsightResults */ export interface InstantResultsActionCreators { /** * Initializes the `instantResults` state for a search box ID. * * @param payload - The initial state and options. * @returns A dispatchable action. */ registerInstantResults(payload: RegisterInstantResultActionCreatorPayload): PayloadAction; /** * Updates the query expression to request instant results for the specified search box ID. * * @param payload - The action creator payload. * @returns A dispatchable action. */ updateInstantResultsQuery(payload: UpdateInstantResultQueryActionCreatorPayload): PayloadAction; /** * Updates the query expression to request instant results for the specified search box ID. * * @param payload - The action creator payload. * @returns A dispatchable action. */ clearExpiredResults(payload: ClearExpiredInstantResultsActionCreatorPayload): PayloadAction; } /** * Loads the `instantResults` reducer and returns possible action creators. * * @param engine - The Headless engine. * @returns An object with the action creators. * * @group Actions * @category InsightResults */ export declare function loadInstantResultsActions(engine: SearchEngine): InstantResultsActionCreators;