compare-by v2.1.0

compare-by

compare-by is a versatile utility library that simplifies sorting arrays of objects by one or multiple object keys. It allows you to specify the sort direction for each key, providing fine-grained control over the sorting process.

Table of Contents

• Installation
• Usage
• Examples
  • Sort by a Single Object Key
  • Sort by a Nested Object Key
  • Sort by Multiple Keys
• Project Badges
• License
• Author
• Acknowledgments

Installation

You can install compare-by via yarn or npm:

Using yarn

yarn add compare-by

Using npm

npm install compare-by

Usage

Here's how you can use compare-by:

import { compareBy } from 'compare-by';
const arr = [{
    name: {
      first: 'John',
      last: 'Doe'
    },
    birthday: new Date(1998, 10, 20),
    profileConfirmed: true,
    age: 24
  },
  /* ... */
];

// sort by single key
arr.sort(compareBy({
  key: 'age',
  dir: 'desc', // 'asc' | 'desc', default: 'asc'
}));

// sort by nested key
arr.sort(compareBy({
  key: (obj) => obj.name.first,
}));

// sort by multiple keys
arr.sort(compareBy([
  { key: 'profileCreated' },
  { key: (obj) => obj.name.last, dir: 'desc' }
]));

Examples

Sort by a Single Object Key

Ascending Order

const arr = [{ x: 'b' }, { x: 'a' }, { x: 'c' }];
arr.sort(compareBy({ key: 'x' }));
console.log(arr); // [{ x: 'a' }, { x: 'b' }, { x: 'c' }]

Descending Order

const arr = [{ x: 'b' }, { x: 'a' }, { x: 'c' }];
arr.sort(compareBy({ key: 'x', dir: 'desc' }));
console.log(arr); // [{ x: 'c' }, { x: 'b' }, { x: 'a' }]

Sort by a Nested Object Key

Ascending Order

const arr = [{ x: { y: 'b' } }, { x: { y: 'a' } }];
arr.sort(compareBy({ key: (el) => el.x.y }));
console.log(arr); // [{ x: { y: 'a' } }, { x: { y: 'b' } }]

Descending Order

const arr = [{ x: { y: 'a' } }, { x: { y: 'b' } }];
arr.sort(compareBy({ key: (el) => el.x.y, dir: 'desc' }));
console.log(arr); // [{ x: { y: 'b' } }, { x: { y: 'a' } }]

Sort by Multiple Keys

const arr = [
	{ x: 'c', y: 'c' },
	{ x: 'b', y: 'a' },
	{ x: 'b', y: 'b' },
];
arr.sort(compareBy([
  { key: 'x' }, // sort by 'x' in ascending order
  { key: 'y', dir: 'desc' } // sort by 'y' in descending order
]));

console.log(arr);
/**
 * [
 *   { x: 'b', y: 'b' },
 *   { x: 'b', y: 'a' },
 *   { x: 'c', y: 'c' },
 * ]
 */

Project Badges

• Npm Package Version: The current version of the npm package.
• Quality Gate Status: Measures the quality of the code using SonarQube.
• Coverage: Shows the code coverage of your project.
• Duplicated Lines (%): Indicates the percentage of duplicated lines in your code.
• Lines of Code: Displays the total lines of code in your project.
• Maintainability Rating: Rates the maintainability of your code.
• Reliability Rating: Rates the reliability of your code.
• Security Rating: Rates the security of your code.

License

This project is licensed under the MIT License.

Author

Tobias Wälde

Acknowledgments

If your project is inspired by or uses other open-source projects, acknowledge them here. It's a good practice and shows respect to the open-source community.

Feel free to customize the author's name, website, license, contribution guidelines, and code of conduct links according to your project's specifics. This improved README provides more context and is well-structured to help users understand, install, and use your library effectively.