Interface DidYouMean

The DidYouMean controller is responsible for handling query corrections.

interface DidYouMean {
    state: DidYouMeanState;
    applyCorrection(): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- DidYouMean

Index

Methods

applyCorrection subscribe

Properties

Methods

applyCorrection

applyCorrection(): void
Executes a search using the suggested query correction.

Typically, you should only call this method when state.hasQueryCorrection is true and state.wasAutomaticallyCorrected is false. When this is the case, you could call this method when the user clicks a link to search with the suggested query correction rather than with the query they originally submitted.

Returns void
- Defined in packages/headless/src/controllers/commerce/search/did-you-mean/headless-did-you-mean.ts:34

subscribe

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

Properties

state

state: DidYouMeanState

A scoped and simplified part of the headless state that is relevant to the DidYouMean controller.