vike/dist/utils/sorter.d.ts

The Framework *You* Control - Next.js & Nuxt alternative for unprecedented flexibility and dependability.

export { higherFirst };
export { lowerFirst };
export { makeFirst };
export { makeLast };
export { reverse };
export type { SortReturn };
/**
 * # How to use `Array.prototype.sort()`
 *
 * ```js
 * elements.sort(sorter);
 * function sorter(element1: unknown, element2: unknown): -1 | 0 | 1
 * ```
 * -1 => element1 first: `elements.indexOf(element1) < elements.indexOf(element2)`
 * +1 => element2 first: `elements.indexOf(element2) < elements.indexOf(element1)`
 *  0 => keep original order of element1 and element2
 */
type SortReturn = -1 | 0 | 1;
/**
 * ```js
 * let arr = [
 *   { price: 10 },
 *   { price: 1000 },
 *   { price: 100 }
 * ]
 * arr = arr.sort(higherFirst(el => el.price))
 * isEqual(arr, [
 *   { price: 1000 },
 *   { price: 100 },
 *   { price: 10 }
 * ])
 * ```
 */
declare function higherFirst<T>(getValue: (element: T) => number): (element1: T, element2: T) => SortReturn;
/**
 * ```js
 * let arr = [
 *   { price: 10 },
 *   { price: 1000 },
 *   { price: 100 }
 * ]
 * arr = arr.sort(lowerFirst(el => el.price))
 * isEqual(arr, [
 *   { price: 10 },
 *   { price: 100 },
 *   { price: 1000 }
 * ])
 * ```
 */
declare function lowerFirst<T>(getValue: (element: T) => number): (element1: T, element2: T) => SortReturn;
/**
 * ```js
 * let arr = [
 *  { name: 'iphone', isRocket: false },
 *  { name: 'starship', isRocket: true }
 * ]
 * arr = arr.sort(makeFirst(el => el.isRocket))
 * isEqual(arr, [
 *  { name: 'starship', isRocket: true },
 *  { name: 'iphone', isRocket: false }
 * ])
 * ```
 */
declare function makeFirst<T>(getValue: (element: T) => boolean | null): (element1: T, element2: T) => SortReturn;
/**
 * ```js
 * let arr = [
 *  { name: 'starship', isRocket: true },
 *  { name: 'iphone', isRocket: false }
 * ]
 * arr = arr.sort(makeLast(el => el.isRocket))
 * isEqual(arr, [
 *  { name: 'iphone', isRocket: false },
 *  { name: 'starship', isRocket: true }
 * ])
 * ```
 */
declare function makeLast<T>(getValue: (element: T) => boolean | null): (element1: T, element2: T) => SortReturn;
/** Reverse order result. */
declare function reverse(sortKey: SortReturn): SortReturn;