hd-utils/lib/utils/array/sortArr.js

A handy utils for modern JS developers

import isBiggerThan from '../validation/isBiggerThan';
import isSmallerThan from '../validation/isSmallerThan';
import isObject from '../validation/isObject';
/**
 * @description It sorts an array of objects or strings or numbers, and if the array is an array of objects, it can
 * sort by a key of the objects.
 * @example sortArr([4,2,1]) // [1,2,4]
 * @example sortArr([{a:2}, {a:1}], {key:"a"}) // [{a:1}, {a:2}]
 * @example sortArr([{a:2}, {a:1}], {getValue:(v) => v.a}) // [{a:1}, {a:2}]
 */
export default function sortArr(arr, options) {
    const { desc, key, getValue } = options || {};
    const sortedArr = [...arr];
    const isObjectArray = isObject(arr[0]);
    const condA = desc ? isBiggerThan : isSmallerThan;
    const condB = desc ? isSmallerThan : isBiggerThan;
    const sortFunc = (a, b) => {
        const prop = key || '';
        let valueA;
        let valueB;
        if (getValue) {
            valueA = getValue(a);
            valueB = getValue(b);
        }
        else {
            if (isObjectArray) {
                valueA = a[prop];
                valueB = b[prop];
            }
            else {
                valueA = a;
                valueB = b;
            }
        }
        return condA(valueA, valueB) ? -1 : condB(valueA, valueB) ? 1 : 0;
    };
    return sortedArr.sort(sortFunc);
}