Interface InstantResultsActionCreators

The instant results action creators.

See Dispatch actions.

interface InstantResultsActionCreators {
    clearExpiredResults(
        payload: ClearExpiredInstantResultsActionCreatorPayload,
    ): { payload: RegisterInstantResultActionCreatorPayload; type: string };
    registerInstantResults(
        payload: RegisterInstantResultActionCreatorPayload,
    ): { payload: RegisterInstantResultActionCreatorPayload; type: string };
    updateInstantResultsQuery(
        payload: UpdateInstantResultQueryActionCreatorPayload,
    ): { payload: UpdateInstantResultQueryActionCreatorPayload; type: string };
}

Index

Methods

clearExpiredResults registerInstantResults updateInstantResultsQuery

Methods

clearExpiredResults

clearExpiredResults(
payload: ClearExpiredInstantResultsActionCreatorPayload,
): { payload: RegisterInstantResultActionCreatorPayload; type: string }
Updates the query expression to request instant results for the specified search box ID.
Parameters
- payload: ClearExpiredInstantResultsActionCreatorPayload
  The action creator payload.
Returns { payload: RegisterInstantResultActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/instant-results/instant-results-actions-loader.ts:56

registerInstantResults

registerInstantResults(
payload: RegisterInstantResultActionCreatorPayload,
): { payload: RegisterInstantResultActionCreatorPayload; type: string }
Initializes the instantResults state for a search box ID.
Parameters
- payload: RegisterInstantResultActionCreatorPayload
  The initial state and options.
Returns { payload: RegisterInstantResultActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/instant-results/instant-results-actions-loader.ts:36

updateInstantResultsQuery

updateInstantResultsQuery(
payload: UpdateInstantResultQueryActionCreatorPayload,
): { payload: UpdateInstantResultQueryActionCreatorPayload; type: string }
Updates the query expression to request instant results for the specified search box ID.
Parameters
- payload: UpdateInstantResultQueryActionCreatorPayload
  The action creator payload.
Returns { payload: UpdateInstantResultQueryActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/instant-results/instant-results-actions-loader.ts:46