DidYouMeanActions (Deprecated)

This is for:

Developer
Warning

Headless v1 has been deprecated. We recommend using the latest version of the Coveo Headless library.

The DidYouMean action creators.

See Dispatch Actions.

Loader Function

loadDidYouMeanActions

Loads the debug reducer and returns possible action creators.

Parameters

  • engine: SearchEngine

    The headless engine.

Returns DidYouMeanActionCreators: The DidYouMean action creators.

DidYouMeanActionCreators

applyDidYouMeanCorrection

Applies a did-you-mean correction.

Parameters

  • correction: string

    The target correction (for example, "corrected string").

Returns PayloadAction<string>: A dispatchable action.

disableDidYouMean

Disables did-you-mean.

Returns PayloadAction: A dispatchable action.

enableDidYouMean

Enables did-you-mean.

Returns PayloadAction: A dispatchable action.