@coveo/headless 3.28.4-pre.4ba48974db → 3.28.4-pre.4dbee2e113

package/dist/definitions/controllers/core/sort/headless-core-sort.d.ts

@@ -32,6 +32,18 @@ export interface Sort extends Controller {
      * Verifies whether the specified sort criterion is the currently active one.
      *
      * @param criterion - The sort criterion to evaluate.
+     * Can be a single criterion or an array of criteria.
+     * The criteria in an array will be applied sequentially. For example, if there's a tie on the 1st criterion, the API uses the 2nd criterion to break the tie. However, this only works when combining:
+     * `SortByRelevancy` followed by one or more `SortByField` or `SortByDate` criteria.
+     * `SortByQRE` followed by one or more `SortByField` or `SortByDate` criteria.
+     * Two or more `SortByField` criteria.
+     * A single `SortByDate` criterion and one or more `SortByField` criteria in any order.
+     *
+     * Examples:
+     * * `SortByRelevancy`, `SortByField`
+     * * `SortByQRE`, `SortByField`
+     * * `SortByDate`, `SortByField`, `SortByField`
+     *
      * @returns `true` if the specified sort criterion is the currently active one; `false` otherwise.
      */
     isSortedBy(criterion: SortCriterion | SortCriterion[]): boolean;

package/dist/esm/utils/version.js

@@ -1,2 +1,2 @@
-export const VERSION = "3.28.4-pre.4ba48974db" || 'Test version';
+export const VERSION = "3.28.4-pre.4dbee2e113" || 'Test version';
 export const COVEO_FRAMEWORK = ['@coveo/atomic', '@coveo/quantic'];