A TypeScript library for comparing values
npm install comparator.ts
A TypeScript library for comparing values.
---
``sh`
pnpm add comparator.tsor
yarn add comparator.ts
or
npm install comparator.ts
`ts
import {
type Comparator,
booleanComparator,
comparing,
nullsLast,
stringComparator,
} from "comparator.ts";
type FeatureConfig = {
enabled?: boolean;
name: string;
};
const data: FeatureConfig[] = [
{ enabled: false, name: "Feature A" },
{ name: "Feature B" },
{ enabled: true, name: "Feature C" },
];
const compareByEnabled: Comparator
(feature) => feature.enabled,
nullsLast(booleanComparator.reversed()),
);
const compareByName: Comparator
(feature) => feature.name,
stringComparator,
);
const sortedData = data.toSorted(compareByEnabled.thenComparing(compareByName));
// sortedData = [
// { enabled: true, name: "Feature C" },
// { enabled: false, name: "Feature A" },
// { name: "Feature B" },
// ]
``
Full API documentation can be found here.
See CONTRIBUTING.md for more information.