Interface Sort

The Sort sub-controller lets you sort the products in a commerce interface.

interface Sort {
    state: SortState;
    isAvailable(criterion: SortCriterion): boolean;
    isSortedBy(criterion: SortCriterion): boolean;
    sortBy(criterion: SortCriterion): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- Sort

Index

Methods

isAvailable isSortedBy sortBy subscribe

Properties

Methods

isAvailable

isAvailable(criterion: SortCriterion): boolean
Verifies whether the specified sort criterion is available.
Parameters
- criterion: SortCriterion
  The sort criterion to look for.
Returns boolean
true if the specified sort criterion is available; false otherwise.
- Defined in packages/headless/dist/definitions/controllers/commerce/core/sort/headless-core-commerce-sort.d.ts:48

isSortedBy

isSortedBy(criterion: SortCriterion): boolean
Verifies whether the specified sort criterion is the currently active one.
Parameters
- criterion: SortCriterion
  The sort criterion to evaluate.
Returns boolean
true if the specified sort criterion is the currently active one; false otherwise.
- Defined in packages/headless/dist/definitions/controllers/commerce/core/sort/headless-core-commerce-sort.d.ts:41

sortBy

sortBy(criterion: SortCriterion): void
Updates the sort criterion and executes a new query.
Parameters
- criterion: SortCriterion
  The new sort criterion.
Returns void
- Defined in packages/headless/dist/definitions/controllers/commerce/core/sort/headless-core-commerce-sort.d.ts:34

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/dist/definitions/controllers/controller/headless-controller.d.ts:10

Properties

state

state: SortState

A scoped and simplified part of the headless state that is relevant to the Sort sub-controller.