Chai Sorted
Chai JS Plugin for testing if an array has sorted values (strings, numbers, booleans). Very helpful when writing tests for features that implement Array.prototype.sort()
Installation
Node.js
Install via npm:
npm install chai-sorted
Use this plugin just like other Chai plugins:
var chai = expect = chaiexpect; // preference and tested with expect chai;
In the browser
There is no planned support for keeping a browser build in this repository, so please consider Webpack or similar tool.
If you do want Browser installation support, please open an issue.
API Usage
.sorted
method
Test for ascending sort order of array
tobe// ortobe
Test for descending sort order of array
tobe
.sortedBy
method
Allows for sorting by an attribute
Test for ascending sort order of array by name
attribute
tobe
Test for descending sort order of array by name
attribute
tobe
.ascendingBy
method
Alternate of sortedBy
but more explicit
Test for ascending sort order of array by name
attribute
tobe
.descendingBy
method
Alternate of sortedBy
but does not require passing true
as a second parameter to sortedBy
. It is the same as doing sortBy("name",true)
Test for descending sort order of array by name
attribute
tobe
ascending
property
Test for ascending sort order of array using a property syntax
tobeascending
descending
property
Test for descending sort order of array using a property syntax
tobedescending
Additional Usage
For additional usage or more help, please see the tests under ./test/