102 lines
3.4 KiB
Markdown
102 lines
3.4 KiB
Markdown
[](https://www.npmjs.org/package/sort-array)
|
|
[](https://www.npmjs.org/package/sort-array)
|
|
[](https://travis-ci.org/75lb/sort-array)
|
|
[](https://david-dm.org/75lb/sort-array)
|
|
[](https://github.com/feross/standard)
|
|
|
|
<a name="module_sort-array"></a>
|
|
|
|
## sort-array
|
|
Sort an array of objects by any property value, at any depth, in any custom order.
|
|
|
|
**Example**
|
|
```js
|
|
const sortBy = require('sort-array')
|
|
```
|
|
<a name="exp_module_sort-array--sortBy"></a>
|
|
|
|
### sortBy(recordset, columnNames, [customOrder]) ⇒ <code>Array</code> ⏏
|
|
**Kind**: Exported function
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| recordset | <code>Array.<object></code> | Input array of objects |
|
|
| columnNames | <code>string</code> \| <code>Array.<string></code> | One or more property expressions to sort by, e.g. `'name'` or `'name.first'`. |
|
|
| [customOrder] | <code>object</code> | Custom sort order definitions. An object where each key is the property expression and the value is an array specifying the sort order. Example: <br> `{ importance: [ 'speed', 'strength', 'intelligence' ]}` |
|
|
|
|
**Example**
|
|
with this data
|
|
```js
|
|
> DJs = [
|
|
{ name: 'Trevor', slot: 'twilight' },
|
|
{ name: 'Chris', slot: 'twilight' },
|
|
{ name: 'Mike', slot: 'afternoon' },
|
|
{ name: 'Rodney', slot: 'morning' },
|
|
{ name: 'Chris', slot: 'morning' },
|
|
{ name: 'Zane', slot: 'evening' }
|
|
]
|
|
```
|
|
|
|
sort by `slot` using the default sort order (alphabetical)
|
|
```js
|
|
> sortBy(DJs, 'slot')
|
|
[ { name: 'Mike', slot: 'afternoon' },
|
|
{ name: 'Zane', slot: 'evening' },
|
|
{ name: 'Chris', slot: 'morning' },
|
|
{ name: 'Rodney', slot: 'morning' },
|
|
{ name: 'Chris', slot: 'twilight' },
|
|
{ name: 'Trevor', slot: 'twilight' } ]
|
|
```
|
|
|
|
specify a custom sort order for `slot`
|
|
```js
|
|
> const slotOrder = [ 'morning', 'afternoon', 'evening', 'twilight' ]
|
|
> sortBy(DJs, 'slot', { slot: slotOrder })
|
|
[ { name: 'Rodney', slot: 'morning' },
|
|
{ name: 'Chris', slot: 'morning' },
|
|
{ name: 'Mike', slot: 'afternoon' },
|
|
{ name: 'Zane', slot: 'evening' },
|
|
{ name: 'Trevor', slot: 'twilight' },
|
|
{ name: 'Chris', slot: 'twilight' } ]
|
|
```
|
|
|
|
sort by `slot` then `name`
|
|
```js
|
|
> sortBy(DJs, ['slot', 'name'], { slot: slotOrder })
|
|
[ { name: 'Chris', slot: 'morning' },
|
|
{ name: 'Rodney', slot: 'morning' },
|
|
{ name: 'Mike', slot: 'afternoon' },
|
|
{ name: 'Zane', slot: 'evening' },
|
|
{ name: 'Chris', slot: 'twilight' },
|
|
{ name: 'Trevor', slot: 'twilight' } ]
|
|
```
|
|
|
|
sort by nested property values (at any depth) using dot notation (e.g. `'inner.number'`)
|
|
```js
|
|
> input = [
|
|
{ inner: { number: 5 } },
|
|
{ inner: { number: 2 } },
|
|
{ inner: { number: 3 } },
|
|
{ inner: { number: 1 } },
|
|
{ inner: { number: 4 } }
|
|
]
|
|
|
|
> sortBy(input, 'inner.number')
|
|
[ { inner: { number: 1 } },
|
|
{ inner: { number: 2 } },
|
|
{ inner: { number: 3 } },
|
|
{ inner: { number: 4 } },
|
|
{ inner: { number: 5 } } ]
|
|
```
|
|
|
|
a custom order for a nested property looks like this:
|
|
```js
|
|
const customOrder = {
|
|
'inner.number': [ 1, 2, 4, 3, 5 ]
|
|
}
|
|
```
|
|
|
|
* * *
|
|
|
|
© 2015-17 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
|