@lesnoypudge/utils/build/sortFns/sortFns.d.ts

lesnoypudge's utils

type SortFnWithSelectors<_Value> = {
    (a: number, b: number): number;
    /**
     * Function for deriving number from provided value.
     */
    select: <_Value>(selectFn: (ab: _Value) => number) => (a: _Value, b: _Value) => number;
};
/**
 * A collection of sorting functions.
 *
 * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort
 */
export declare const sortFns: {
    /**
     * Sort numbers from smallest to biggest.
     *
     * Alias to smallToBig.
     */
    ascending: SortFnWithSelectors<unknown>;
    /**
     * Sort numbers from smallest to biggest.
     *
     * Alias to ascending.
     */
    smallToBig: SortFnWithSelectors<unknown>;
    /**
     * Sort numbers from biggest to smallest.
     *
     * Alias to bigToSmall.
     */
    descending: SortFnWithSelectors<unknown>;
    /**
     * Sort numbers from biggest to smallest.
     *
     * Alias to descending.
     */
    bigToSmall: SortFnWithSelectors<unknown>;
};
export {};