# clay-list-sorter

> Sorter functions for ClayDB list

Latest version **2.0.2** (published 2019-03-01) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install clay-list-sorter
pnpm add clay-list-sorter
yarn add clay-list-sorter
bun add clay-list-sorter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2019-03-01 |
| First published | 2017-04-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 0 |
| Unpacked size | 36 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi, realglobe |
| Keywords | ClayDB |

## Links

- npm: https://www.npmjs.com/package/clay-list-sorter
- Repository: https://github.com/realglobe-Inc/clay-list-sorter
- Homepage: https://github.com/realglobe-Inc/clay-list-sorter#readme
- Issues: https://github.com/realglobe-Inc/clay-list-sorter/issues
- npm.io page: https://npm.io/package/clay-list-sorter

## Recent versions

- 2.0.2 (latest) — 2019-03-01
- 2.0.1 — 2017-04-05

## README

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

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![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

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Sorter functions for ClayDB list

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

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


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

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 } ]
}

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Functions.md.hbs" Start -->

<a name="section-doc-guides-03-functions-md"></a>

Functions
---------

Available functions

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


<!-- Section from "doc/guides/03.Functions.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [Apache-2.0 License](https://github.com/realglobe-Inc/clay-list-sorter/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

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

<!-- Links End -->

---
_Source: https://npm.io/package/clay-list-sorter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._