https://github.com/pratishshr/sort-o
Utility for your sorting needs.
https://github.com/pratishshr/sort-o
object-sort sort-keys sort-object-keys sorted-arrays
Last synced: 5 months ago
JSON representation
Utility for your sorting needs.
- Host: GitHub
- URL: https://github.com/pratishshr/sort-o
- Owner: pratishshr
- License: mit
- Created: 2017-11-08T10:13:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-05T13:13:12.000Z (over 8 years ago)
- Last Synced: 2025-10-13T02:21:47.668Z (8 months ago)
- Topics: object-sort, sort-keys, sort-object-keys, sorted-arrays
- Language: JavaScript
- Homepage:
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sort-o
[](https://www.npmjs.com/package/sort-o)
[](https://travis-ci.org/pratishshr/sort-o)
[](https://www.npmjs.com/package/sort-o)
> Utility for your sorting needs.
## Features
* Sort keys of an object.
* Sort arrays by length and value.
* TBD..
## Installation
```bash
npm install --save sort-o
```
```bash
yarn add sort-o
```
## Usage
#### Require
```js
const sorto = require('sort-o');
sorto.sort(data);
```
#### ES6 Import
```js
import { sort, sortOrder } from 'sort-o';
sort(data, sortOrder.ASC);
```
## API
#### sorto.sort(data [, sortOrder])
Sort data as per the specified order.
* Suppports deep sorting for object keys.
#### sortOrder
| sortOrder | Type | Value | Description |
| ----------------------------- | -------- | ------------- | ---------------------------------- |
| **sortOrder.ASC** `(default)` | `string` | 'asc' | Sort in ascending order |
| **sortOrder.DESC** | `string` | 'desc' | Sort in descending order |
| **sortOrder.ASC_LENGTH** | `string` | 'asc_length' | Sort in ascending order by length |
| **sortOrder.DESC_LENGTH** | `string` | 'desc_length' | Sort in descending order by length |
## Example
#### Sort keys of an object.
```js
import { sortKeys, sortOrder } from 'sort-o';
const input = {
a: 1,
c: {
b: 2,
c: 3,
a: 1
},
b: 2
};
sortKeys(input, sortOrder.ASC);
// => {
// a: 1,
// b: 2,
// c:{
// a: 1,
// b: 2,
// c: 3
// }
// }
```
#### Sort array of strings.
```js
import { sort, sortOrder } from 'sort-o';
const input = ['dddd', 'bb', 'ccc', 'a'];
sort(input, sortOrder.LENGTH);
// => [
// 'a',
// 'bb',
// 'ccc',
// 'dddd'
// ]
```