import type { PayloadAction } from '@reduxjs/toolkit'; import type { SearchEngine } from '../../app/search-engine/search-engine.js'; import type { CorrectionMode } from './did-you-mean-state.js'; /** * The DidYouMean action creators. * * @group Actions * @category DidYouMean */ export interface DidYouMeanActionCreators { /** * Applies a did-you-mean correction. * * @param correction - The target correction (for example, "corrected string"). * @returns A dispatchable action. */ applyDidYouMeanCorrection(correction: string): PayloadAction; /** * Disables did-you-mean. * * @returns A dispatchable action. */ disableDidYouMean(): PayloadAction; /** * Enables automatic query correction * * @returns A dispatchable action. */ enableAutomaticQueryCorrection(): PayloadAction; /** * Disables automatic query correction * * @returns A dispatchable action. */ disableAutomaticQueryCorrection(): PayloadAction; /** * Enables did-you-mean. * * @returns A dispatchable action. */ enableDidYouMean(): PayloadAction; /** * Sets the query correction mode. * * @param mode - The query correction mode to use. Must be either `"legacy"` (index based) or `"next"` (query suggestions based). * @returns A dispatchable action. * */ setCorrectionMode(mode: CorrectionMode): PayloadAction; } /** * Loads the `debug` reducer and returns possible action creators. * * @param engine - The headless engine. * @returns An object holding the action creators. * * @group Actions * @category DidYouMean */ export declare function loadDidYouMeanActions(engine: SearchEngine): DidYouMeanActionCreators;