npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rank-me

v0.0.1

Published

Leaderboards for the ranking of non-unique usernames.

Downloads

6

Readme

rank-me

Minimalistic leaderboards for the ranking of non-unique usernames.

Every new name/score pair added to a leaderboard will generate a unique id associated with the transaction. This id can be stored and used to query additional information about the transaction at a later time.

Installation

npm install rank-me

API

Constructor

var Leaderboard = require('rank-me');

var leaderboard = new Leaderboard('leaderboard_id', [options]);

Options

  • host (default: 127.0.0.1)
  • The host address of the redis server.
  • port (default: 6379)
  • The port of the redis server.
  • db (default: 0)
  • Select the specified redis DB.

Methods

getScoreCount(callback)

Gets the total # of stores stored in the leaderboard.

leaderboard.getScoreCount(function(err, count) {
    // count - The # of scores in the leaderboard.
});

addScore(name, score, callback)

Adds a score to the leaderboard for a given user name. Names are not required to be unique. For every name/score that is added to the leaderboard, a unique entryId will be generated. This unique id is passed as a parameter to the callback of addScore. Using this unique id, information about the added score entry can be queried if desired.

leaderboard.addScore('Bob', 4, function(err, entryId) {
    // entryId - The unique id for the added score.
});

getRank(entryId, callback)

Gets the rank for a given leaderboard entry.

leaderboard.getRank(entryId, function(err, rank) {
    // rank - The rank of the user, or -1 if it didn't exist.
});

getScoresForRankRange(fromRank, toRank, callback)

Gets the names and scores for a given range of ranks. Note that fromRank and toRank indices are both inclusive.

//   Get the top 3 ranks:
leaderboard.getScoresForRankRange(0, 2, function(err, list) {
    // list - List of names ordered from highest to lowest score
    // [
    //   { name: 'bob', rank: 0, score: 30 },
    //   { name: 'joe', rank: 1, score: 20 },
    //   { name: 'sue', rank: 2, score: 10 }
    // ]
});