Module order

Composable comparison functions and combinators for sorting operations.

Provides composable comparison functions for use with Array.sort() and other comparator-based operations.

Usage

import { ascending, descending, by, compound, nullish } from '@metreeca/core/comparators';

// Basic sorting

const numbers = [3, 1, 4, 1, 5];
numbers.sort(ascending);  // [1, 1, 3, 4, 5]
numbers.sort(descending); // [5, 4, 3, 1, 1]

// Sort by property

const users = [
  { name: 'Bob', age: 25 },
  { name: 'Alice', age: 30 }
];

users.sort(by(user => user.name));        // Sort by name ascending
users.sort(by(user => user.age, descending)); // Sort by age descending

// Combine multiple criteria

const data = [
  { category: 'B', priority: 2 },
  { category: 'A', priority: 1 },
  { category: 'A', priority: 3 }
];

data.sort(compound(
  by(item => item.category),    // First by category
  by(item => item.priority)     // Then by priority
));

// Handle null/undefined values

const values = [3, null, 1, undefined, 2];
values.sort(nullish(ascending)); // [null, undefined, 1, 2, 3]
Copy