# orderby

> Sort collections by fields and getters. Inspired by angular orderBy

Latest version **1.1.0** (published 2015-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install orderby
pnpm add orderby
yarn add orderby
bun add orderby
```

## 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 | 1.1.0 |
| Published | 2015-05-12 |
| First published | 2015-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Good Eggs |
| Maintainers | goodeggs |
| Keywords | orderBy sort angular |

## Links

- npm: https://www.npmjs.com/package/orderby
- Repository: https://github.com/goodeggs/orderby
- Issues: https://github.com/goodeggs/orderby/issues
- npm.io page: https://npm.io/package/orderby

## Recent versions

- 1.1.0 (latest) — 2015-05-12
- 1.0.0 — 2015-05-12

## README

# orderBy

Sort collections by fields and getters. Inspired by Angular's orderBy filter

[![build status][travis-badge]][travis-link]
[![npm version][npm-badge]][npm-link]
[![MIT license][license-badge]][license-link]
[![we're hiring][hiring-badge]][hiring-link]


## Usage

```
npm install orderby
```

```js
var orderBy = require('orderby');

var collection = [
  {age: 100 , name: 'Michael'}
  {age: 25 , name: 'Ben'}
  {age: 100, name: 'Danny'}
  {age: 25, name: 'Max'}
];

// sort by fields
orderBy(collection, ['age', 'name']);

// sort by getters
orderBy(collection, [function(person){ return person.name.length }]);

// reverse each sort individually
orderBy(collection, [
  {
    predicate: function(person){ return person.name.length },
    reverse: true
  },
  {
    predicate: 'age',
    reverse: false
  }
]);

```

## Contributing

Please follow our [Code of Conduct](https://github.com/goodeggs/orderby/blob/master/CODE_OF_CONDUCT.md)
when contributing to this project.

```
$ git clone https://github.com/goodeggs/orderby && cd orderby
$ npm install
$ npm test
```

_Module scaffold generated by [generator-goodeggs-npm](https://github.com/goodeggs/generator-goodeggs-npm)._


[travis-badge]: http://img.shields.io/travis/goodeggs/orderby.svg?style=flat-square
[travis-link]: https://travis-ci.org/goodeggs/orderby
[npm-badge]: http://img.shields.io/npm/v/orderby.svg?style=flat-square
[npm-link]: https://www.npmjs.org/package/orderby
[license-badge]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[license-link]: LICENSE.md
[hiring-badge]: https://img.shields.io/badge/we're_hiring-yes-brightgreen.svg?style=flat-square
[hiring-link]: http://goodeggs.jobscore.com/?detail=Open+Source&sid=161

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