@thi.ng/compare

@thi.ng/compare

npm versionnpm downloads Mastodon Follow

[!NOTE] This is one of 190 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

About

Comparators with optional support for types implementing the @thi.ng/api ICompare interface.

Since v1.2.0 additional higher-order comparators are included, e.g. to reverse the ordering of an existing comparator and allow hierarchical sorting by multiple keys/dimensions, each with their own optional comparator. See examples below.

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/compare

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/compare"></script>

Skypack documentation

For Node.js REPL:

const compare = await import("@thi.ng/compare");

Package sizes (brotli'd, pre-treeshake): ESM: 601 bytes

Dependencies

Usage examples

Several projects in this repo's /examples directory are using this package:

ScreenshotDescriptionLive demoSource
Color palette generation via dominant color extraction from uploaded imagesDemoSource
Full umbrella repo doc string search w/ paginated resultsDemoSource
Triple store query results & sortable tableDemoSource

API

Generated API docs

ICompare support

import { ICompare } from "@thi.ng/api";
import { compare } from "@thi.ng/compare";

class Foo implements ICompare<Foo> {

x: number;

constructor(x: number) {
this.x = x;
}

compare(o: Foo) {
return compare(this.x, o.x);
}
}

compare(new Foo(1), new Foo(2));
// -1

Cluster sort w/ multiple sort keys

Key-based object comparison is supported for 1 - 4 keys / dimensions.

import * as cmp from "@thi.ng/compare";

const src = [
{ id: "charlie", age: 66 },
{ id: "bart", age: 42 },
{ id: "alice", age: 23 },
{ id: "dora", age: 11 },
];

// cluster sort by id -> age (default comparators)
[...src].sort(cmp.compareByKeys2("id", "age"));
// [
// { id: 'alice', age: 23 },
// { id: 'bart', age: 42 },
// { id: 'charlie', age: 66 },
// { id: 'dora', age: 11 }
// ]

// cluster sort by age -> id (default comparators)
[...src].sort(cmp.compareByKeys2("age", "id"));
// [
// { id: 'dora', age: 11 },
// { id: 'alice', age: 23 },
// { id: 'bart', age: 42 },
// { id: 'charlie', age: 66 }
// ]

// cluster sort by age -> id
// (custom comparator for `age` key)
[...src].sort(cmp.compareByKeys2("age", "id", cmp.compareNumDesc));
// [
// { id: 'charlie', age: 66 },
// { id: 'bart', age: 42 },
// { id: 'alice', age: 23 },
// { id: 'dora', age: 11 }
// ]

// using `reverse()` comparator for `id`
[...src].sort(cmp.compareByKeys2("age", "id", cmp.compare, cmp.reverse(cmp.compare)));
// [
// { id: 'dora', age: 11 },
// { id: 'alice', age: 23 },
// { id: 'bart', age: 42 },
// { id: 'charlie', age: 66 }
// ]

Authors

If this project contributes to an academic publication, please cite it as:

@misc{thing-compare,
title = "@thi.ng/compare",
author = "Karsten Schmidt",
note = "https://thi.ng/compare",
year = 2016
}

License

© 2016 - 2024 Karsten Schmidt // Apache License 2.0

Generated using TypeDoc