npm Version License Build Status Code Climate devDependency Status peerDependency Status

Chai Sorted

配列にソートされた値 (文字列、数値、ブーリアン) があるかどうかをテストするための Chai JS プラグイン。Array.Array.prototype.sort() を実装する機能のテストを行う際に、非常に役立ちます。

インストール

Node.js

npm 経由でインストール

npm install chai-sorted

他の Chai プラグインと同様に、このプラグインを使用します。

var chai = require("chai"),
    expect = chai.expect; // preference and tested with expect

chai.use(require("chai-sorted"));

ブラウザ内

このリポジトリにブラウザのビルドを保持するための計画されたサポートはありません。したがって、Webpack または同様のツールを検討してください。

ブラウザインストールのサポートが必要な場合は、問題を開いてください。

API の使用方法

.sorted メソッド

配列の昇順ソートの順序をテストします。

expect(["a","b"]).to.be.sorted()
// or
expect(["a","b"]).to.be.sorted({descending: false}) 

配列の降順ソートの順序をテストします。

expect(["b","apples"]).to.be.sorted({descending: true})

.sortedBy メソッド

属性によるソートを許可します。

name 属性による配列の昇順のソート順序をテストします。

expect([{id:2,name:"apple"},{id:3,name:"bat"}]).to.be.sortedBy("name")

name 属性による配列の降順のソート順序をテストします。

expect([{id:2,name:"bat"},{id:3,name:"apples"}]).to.be.sortedBy("name", {descending: true})

.ascendingBy メソッド

sortedBy の代替ですが、より明示的です。

name 属性による配列の昇順のソート順序をテストします。

expect([{id:2,name:"apple"},{id:3,name:"bat"}]).to.be.ascendingBy("name")

.descendingBy メソッド

sortedBy の代替ですが、第二引数に true を渡す必要はありません。sortBy("name",true) と同じです。

name 属性による配列の降順のソート順序をテストします。

expect([{id:2,name:"bat"},{id:3,name:"apples"}]).to.be.descendingBy("name")

.ascending プロパティ

プロパティ構文を使用して配列の昇順のソート順序をテストします。

expect(["a","b"]).to.be.ascending

.descending プロパティ

プロパティ構文を使用して配列の降順のソート順序をテストします。

expect(["b","apples"]).to.be.descending

追加の使用方法

追加の使用方法またはさらなるサポートについては、./test/ 以下のテストを参照してください。