Plugin which handles ranking of data for Tymly framework

Usage no npm install needed!

<script type="module">
  import wmfsTymlyRankingsPlugin from 'https://cdn.skypack.dev/@wmfs/tymly-rankings-plugin';



Tymly Plugin npm (scoped) CircleCI codecov CodeFactor Dependabot badge Commitizen friendly JavaScript Style Guide license

Plugin which handles ranking of data

On tymly startup, this plugin searches the loaded blueprints for .json files in ranking directory. These ranking files indicate what factors should contribute to the ranking score and where to find the value to score. The plugin looks at these factors, and finds the corresponding weights in the registry-keys. With these weights, the plugin generates an SQL View statement which forms a table with scores per factor and a total score for each 'source' row.

The plugin also supplies a state-resource so it can be called to refresh a ranking, which will look to the database for up-to-date registry-keys.

See the test blueprint in /test/fixtures for an example of how to do this.


$ npm install tymly-rankings-plugin --save


Before running the tests, you'll need a test PostgreSQL database available and set a PG_CONNECTION_STRING environment variable to point to it, for example:


Once the environment variables have been set, you can run the tests like this:

$ npm test