Interface RecentResultsActionCreators

The RecentResults action creators

See Dispatch actions.

interface RecentResultsActionCreators {
    clearRecentResults(): { payload: void; type: string };
    pushRecentResult(payload: Result): { payload: Result; type: string };
    registerRecentResults(
        payload: RegisterRecentResultsCreatorPayload,
    ): { payload: RegisterRecentResultsCreatorPayload; type: string };
}

Index

Methods

clearRecentResults pushRecentResult registerRecentResults

Methods

clearRecentResults

clearRecentResults(): { payload: void; type: string }
Clear the recent results list.

Returns { payload: void; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/recent-results/recent-results-actions-loader.ts:33

pushRecentResult

pushRecentResult(payload: Result): { payload: Result; type: string }
Add the recent result to the list.
Parameters
- payload: Result
  (Result) The result to add.
Returns { payload: Result; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/recent-results/recent-results-actions-loader.ts:40

registerRecentResults

registerRecentResults(
payload: RegisterRecentResultsCreatorPayload,
): { payload: RegisterRecentResultsCreatorPayload; type: string }
Initialize the recentResults state.
Parameters
- payload: RegisterRecentResultsCreatorPayload
  (RegisterRecentResultsCreatorPayload) The initial state and options.
Returns { payload: RegisterRecentResultsCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/recent-results/recent-results-actions-loader.ts:25