Interface SortCriteriaActionCreators

The sort criteria action creators.

See Dispatch actions.

interface SortCriteriaActionCreators {
    registerSortCriterion(
        criterion: SortCriterion | SortCriterion[],
    ): { payload: SortCriterion | SortCriterion[]; type: string };
    updateSortCriterion(
        criterion: SortCriterion | SortCriterion[],
    ): { payload: SortCriterion | SortCriterion[]; type: string };
}

Index

Methods

registerSortCriterion updateSortCriterion

Methods

registerSortCriterion

registerSortCriterion(
criterion: SortCriterion | SortCriterion[],
): { payload: SortCriterion | SortCriterion[]; type: string }
Initializes the sortCriteria query parameter. For more information, refer to the documentation on query parameters.
Parameters
- criterion: SortCriterion | SortCriterion[]
  The initial sort criterion.
Returns { payload: SortCriterion | SortCriterion[]; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/sort-criteria/sort-criteria-actions-loader.ts:23

updateSortCriterion

updateSortCriterion(
criterion: SortCriterion | SortCriterion[],
): { payload: SortCriterion | SortCriterion[]; type: string }
Updates the sortCriteria query parameter. For more information, refer to the documentation on query parameters.
Parameters
- criterion: SortCriterion | SortCriterion[]
  The sort criterion to set.
Returns { payload: SortCriterion | SortCriterion[]; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/sort-criteria/sort-criteria-actions-loader.ts:33