sort-by-value/README.md

Re-order the objects in an array so that values of a specified property match the order of a provided array of values.

# sort-by-value [![NPM version](https://img.shields.io/npm/v/sort-by-value.svg?style=flat)](https://www.npmjs.com/package/sort-by-value) [![NPM monthly downloads](https://img.shields.io/npm/dm/sort-by-value.svg?style=flat)](https://npmjs.org/package/sort-by-value)  [![NPM total downloads](https://img.shields.io/npm/dt/sort-by-value.svg?style=flat)](https://npmjs.org/package/sort-by-value) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/sort-by-value.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/sort-by-value)

> Re-order the objects in an array so that values of a specified property match the order of a provided array of values.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save sort-by-value
```

Install with [yarn](https://yarnpkg.com):

```sh
$ yarn add sort-by-value
```

## Usage

```js
var sortBy = require('sort-by-value');
sortBy(array, {
  prop: 'foo', // the property name to sort by
  values: ['a', 'b', 'c'] // the property values to sort by
});
```

## Example

```js
var arr = [
  {title: 'Foo'},
  {title: 'Baz'},
  {title: 'Bar'},
  {title: 'Qux'},
  {title: 'Faz'},
  {title: 'Fez'}
];

var res = sortBy(arr, {
  prop: 'title',
  values: ['Faz', 'Qux', 'Bar'],
  normalize: function(val) {
    return val;
  }
});

console.log(res);
// [ { title: 'Faz' },
//   { title: 'Qux' },
//   { title: 'Bar' },
//   { title: 'Foo' },
//   { title: 'Baz' },
//   { title: 'Fez' } ]
```

## About

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.

### Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

### Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

```sh
$ npm install && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)

### License

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on April 27, 2017._