btree-leaderboard

Simple score-based leaderboard built on btree-core.

Higher scores rank first. Equal scores break ties by player id.

Install

npm install btree-leaderboard

Usage

const Leaderboard = require('btree-leaderboard');

const board = new Leaderboard();

board.set('alice', 100);
board.set('bob', 250);
board.add('alice', 50); // alice -> 150

board.getScore('bob'); // 250
board.getRank('bob');  // 1

board.top(2);
// [
//   { playerId: 'bob', score: 250, rank: 1 },
//   { playerId: 'alice', score: 150, rank: 2 }
// ]

API

| Method | Description | | --- | --- | | set(playerId, score) | Set absolute score | | add(playerId, delta) | Add/subtract points | | getScore(playerId) | Current score | | getRank(playerId) | 1-based rank | | top(limit?) | Top N entries (default 10) | | delete(playerId) | Remove player | | clear() | Reset board | | toArray() | Full ranked list | | size | Number of players |

License

MIT