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:

$ npm install --save sort-by-value

Install with yarn:

$ yarn add sort-by-value

Usage

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

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.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project’s readme.md is generated by verb, please don’t edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ 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:

$ npm install && npm test

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.6.0, on April 27, 2017.