!@thi.ng/compare

!npm downloads

> [!NOTE]
> This is one of 214 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
- Generic comparison
- Additional comparators
- Operators
- Status
- Installation
- Dependencies
- Usage examples
- API
- ICompare support
- Cluster sort w/ multiple sort keys
- Authors
- License

About

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

$3

- compare()

$3

- compareByKey()
- compareByKeys2()
- compareByKeys3()
- compareByKeys4()
- compareLengthAsc()
- compareLengthDesc()
- compareLex()
- compareNumAsc()
- compareNumDesc()
- reverse()

$3

- numericOp()
- stringOp()
- eq()
- gt()
- gte()
- lt()
- lte()
- neq()

Status

STABLE - used in production

Search or submit any issues for this package

Installation

``bash
yarn add @thi.ng/compare
`

ESM import:

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

Browser ESM import:

`html

`

JSDelivr documentation

For Node.js REPL:

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

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

Dependencies

- @thi.ng/api

Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)

Usage examples

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

| Screenshot | Description | Live demo | Source |
|:-------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------|:--------------------------------------------------------|:-------------------------------------------------------------------------------------|
| | Color palette generation via dominant color extraction from uploaded images | Demo | Source |
| | Piechart visualization of CSV data | Demo | Source |
| | Full umbrella repo doc string search w/ paginated results | Demo | Source |
| | Tree-based UI to find & explore thi.ng projects via their associated keywords | Demo | Source |
| | Triple store query results & sortable table | Demo | Source |

API

Generated API docs

$3

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

class Foo implements ICompare {

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
`

$3

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

`ts tangle:export/readme1.ts
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)
console.log(
[...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)
console.log(
[...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)
console.log(
[...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
console.log(
[...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

- Karsten Schmidt

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

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

License

© 2016 - 2026 Karsten Schmidt // Apache License 2.0