orderby-ts v2.0.1

orderby-ts

orderby-ts is a lightweight, type-safe utility for sorting arrays in TypeScript. It works with arrays of numbers, strings, or objects and is designed to be framework-agnostic, making it easy to use in any TypeScript or JavaScript project.

🚀 Features

• Sort arrays by keys or custom selector functions.
• Supports ascending and descending order.
• Framework-agnostic: works with Angular, React, Node.js, and plain TypeScript/JavaScript.
• Immutable: does not modify the original array.
• Fully type-safe and developer-friendly.

📦 Installation

You can install orderby-ts using npm or yarn:

npm install orderby-ts

Or with Yarn:

yarn add orderby-ts

🛠️ Usage

Importing the Function

import 'orderby-ts';

Sorting Arrays of Numbers

const numbers = [5, 3, 8, 1];
const sortedNumbers = numbers.orderBy((num) => num);
console.log(sortedNumbers); // Output: [1, 3, 5, 8]

Sorting Arrays of Custom Selector Function

const users = [
  { id: 1, name: 'Alice', age: 30 },
  { id: 2, name: 'Bob', age: 25 },
  { id: 3, name: 'Charlie', age: 35 },
];

const sortedByName = users.orderBy((o) => o.name);
console.log(sortedByName);
// Output: [
//   { id: 1, name: 'Alice', age: 30 },
//   { id: 2, name: 'Bob', age: 25 },
//   { id: 3, name: 'Charlie', age: 35 }
// ];

const sortedByAgeDesc = users.orderBy((o) => o.age, 'DESC');
console.log(sortedByAgeDesc);
// Output: [
//   { id: 3, name: 'Charlie', age: 35 },
//   { id: 1, name: 'Alice', age: 30 },
//   { id: 2, name: 'Bob', age: 25 }
// ];

Handling Empty Arrays

const emptyArray = [];
const sorted = emptyArray.orderBy((item) => item);
console.log(sorted); // Output: []

🔍 API

orderBy<T>(array: T[], selector: keyof T | (item: T) => any, order?: 'ASC' | 'DESC'): T[]

Parameters:

• array: The array to be sorted.
• selector: A key or a custom selector function to define the sorting logic.
• order (optional): indicating whether to sort in ascending order. Default is ASC.

Returns:

• A new, sorted array.

🧪 Tests

The project includes comprehensive tests written with Jest. To run the tests, clone the repository and run the following commands:

npm install
npm test

💻 Development

Requirements

• Node.js (>= 14)
• TypeScript (>= 4.0)

Building the Project

npm run build

Linting and Formatting

This project uses ESLint and Prettier for linting and code formatting:

npm run lint     # Check for linting issues
npm run lint:fix # Automatically fix linting issues
npm run format   # Format the code with Prettier

🤝 Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/my-feature).
3. Commit your changes (git commit -am 'Add my feature').
4. Push to the branch (git push origin feature/my-feature).
5. Open a Pull Request.

Please make sure your code follows the existing style and passes all tests.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🌟 Support

If you like this project, give it a star ⭐ on GitHub!

🔗 Links

• GitHub Repository
• npm Package