clay-list-sorter

clay-list-sorter
==========

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/realglobe-Inc/clay-list-sorter
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/clay-list-sorter
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/clay-list-sorter.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/clay-list-sorter
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/clay-list-sorter.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/clay-list-sorter/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/clay-list-sorter
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/clay-list-sorter.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/clay-list-sorter.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/clay-list-sorter
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/clay-list-sorter.svg
[bd_npm_url]: http://www.npmjs.org/package/clay-list-sorter
[bd_npm_shield_url]: http://img.shields.io/npm/v/clay-list-sorter.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

Sorter functions for ClayDB list

Installation
-----

``bash
$ npm install clay-list-sorter --save
`

Usage
---------

`javascript
'use strict'

const { sortArray } = require('clay-list-sorter')

{
let source = [ { name: 'foo', index: 2 }, { name: 'bar', index: 1 } ]
let sort = 'index'

let sorted = sortArray(source, sort)
console.log(sorted) // -> [ { name: 'bar', index: 1 }, { name: 'foo', index: 2 } ]
}

`

Functions
---------

Available functions

| Signature | Description |
| ---- | ----------- |
| sortArray(array, conditions) -> Object[]` | Sort array with condition |

License
-------
This software is released under the Apache-2.0 License.

Links
------

+ [ClayDB][clay_d_b_url]
+ [Realglobe, Inc.][realglobe,_inc__url]

[clay_d_b_url]: https://github.com/realglobe-Inc/claydb
[realglobe,_inc__url]: http://realglobe.jp