@iplatformglobal/array-multi-sort

Array Multi Sort

Array helper for soring array object on multiple key values with ordering

Instalation

yarn add @iplatformglobal/array-multi-sort or

or

npm install @iplatformglobal/array-multi-sort

Usage

Sorts an array against keys with defined order direction

// Data to be sorted
const data = [{
  id: 1,
  name: 'Tester',
  age: 20,
}, {
  id: 1,
  name: 'Taster',
  age: 21,
}, {
  id: 1,
  name: 'Tester',
  age: 21,
}];

// Instructions for how to sort the data
const sortColumns = [{
  key: 'name',
  direction: 'ASC',
}];

arrayMultiSort(data, sortColumns)

Testing

Testing is handled by Jest and the packages has the following commands setup

• yarn test
• yarn test:watch

Contributing

All contributions are welcome, and can be done by cloning the repo and running yarn install.

Ensure that there are no errors in the tests or linter and ensure that your commit messages comply to the following format:

• break: COMMIT_MSG - changes in the code that changes the way other users would need to implement it.
• feat: COMMIT_MSG - adding a new feature or capability to the helper.
• fix: COMMIT_MSG - any bugs or minor updates that fixes the existing code without adding or removing any capabilities.
• none: COMMIT_MSG - used for simple updates like documentation, aka NO code has changed.

There are git hooks configured to ensure commit message format as well as test and linter compliance.

History

Discover the release history by heading on over to the releases page.

License

Unless stated otherwise all works are:

• Copyright © 2017+ iPlatform

and licensed under:

• MIT License