realtime-leaderboard
Version:
Real-time powerful leaderboard with Redis
216 lines • 10.1 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Leaderboard = exports.LeaderboardUpdateOptions = exports._LeaderboardUpdateOptions = void 0;
var CustomRedisClient_1 = require("./CustomRedisClient");
var _LeaderboardUpdateOptions;
(function (_LeaderboardUpdateOptions) {
_LeaderboardUpdateOptions["updateOnly"] = "XX";
_LeaderboardUpdateOptions["createOnly"] = "NX";
_LeaderboardUpdateOptions["createAndUpdateIfLess"] = "LT";
_LeaderboardUpdateOptions["createAndUpdateIfGrater"] = "GT";
_LeaderboardUpdateOptions["createAndIncrement"] = "INCR";
})(_LeaderboardUpdateOptions = exports._LeaderboardUpdateOptions || (exports._LeaderboardUpdateOptions = {}));
var LeaderboardUpdateOptions;
(function (LeaderboardUpdateOptions) {
LeaderboardUpdateOptions["updateOnly"] = "updateOnly";
LeaderboardUpdateOptions["createOnly"] = "createOnly";
LeaderboardUpdateOptions["createAndUpdateIfLess"] = "createAndUpdateIfLess";
LeaderboardUpdateOptions["createAndUpdateIfGrater"] = "createAndUpdateIfGrater";
LeaderboardUpdateOptions["createAndIncrement"] = "createAndIncrement";
})(LeaderboardUpdateOptions = exports.LeaderboardUpdateOptions || (exports.LeaderboardUpdateOptions = {}));
/**
* Leaderboard Class
*/
var Leaderboard = /** @class */ (function () {
/**
* Leaderboard class constructor
*
* @param redisClient - redisClient >>> Supports
*
* Redis {@link https://www.npmjs.com/package/redis}
*
* ioRedis {@link https://www.npmjs.com/package/ioredis}
*
* @param leaderboardId - Leaderboard Identifier
* @param opts - Leaderboard Options
*/
function Leaderboard(redisClient, leaderboardId, opts) {
this.leaderboardId = leaderboardId;
this.opts = opts;
this.client = redisClient instanceof CustomRedisClient_1.CustomRedisClient ?
redisClient :
new CustomRedisClient_1.CustomRedisClient(redisClient);
this.clientType = this.client.type;
}
Leaderboard.getUpdateOption = function (optionInput) {
var defaultOpts = _LeaderboardUpdateOptions.updateOnly;
return _LeaderboardUpdateOptions[optionInput] || defaultOpts; /* istanbul ignore file */
};
Leaderboard.prototype.resetLeaderboard = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, this.client.zremrangebyrank(this.leaderboardId, 0, -1)];
});
});
};
Leaderboard.prototype.getNoOfUsers = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, this.client.zcount(this.leaderboardId, "-inf", "+inf")];
});
});
};
/**
* Create User in Leaderboard
*
* @param userId - Unique User Identifier (ex: userId, username, email)
* @param score - User's Score/Point
*/
Leaderboard.prototype.createUser = function (userId, score) {
return __awaiter(this, void 0, void 0, function () {
var updateOption;
return __generator(this, function (_a) {
updateOption = Leaderboard.getUpdateOption(LeaderboardUpdateOptions.createOnly);
return [2 /*return*/, this.client.zadd(this.leaderboardId, updateOption, score, userId)];
});
});
};
/**
* Update/Upsert User Record. According to LeaderboardUpdateOption selection.
*
* "updateOnly" : Never allows you to create new records if user doesn't exist.
*
* "createOnly" : Never allows you to update any user score.
*
* "createAndUpdateIfLess" : If user not exist, creates records, otherwise updates if new score
* is less than current one.
*
* "createAndUpdateIfGrater" : If user not exist, creates records, otherwise updates if new score
* is greater than current one.
*
* "createAndIncrement" : If user not exist, creates records, otherwise adds up new score.
*
* @param userId - Unique User Identifier (ex: userId, username, email)
* @param score - User's Score/Point
*/
Leaderboard.prototype.updateUser = function (userId, score) {
return __awaiter(this, void 0, void 0, function () {
var updateOption;
return __generator(this, function (_a) {
updateOption = Leaderboard.getUpdateOption(this.opts.update);
return [2 /*return*/, this.client.zadd(this.leaderboardId, updateOption, score, userId)];
});
});
};
/**
* Get User's Score by user identifier.
*
* @param userId - Unique User Identifier (ex: userId, username, email)
*/
Leaderboard.prototype.getScore = function (userId) {
return __awaiter(this, void 0, void 0, function () {
var score;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.client.zscore(this.leaderboardId, userId)];
case 1:
score = _a.sent();
return [2 /*return*/, score == null || score === undefined ? null : parseFloat(score)];
}
});
});
};
/**
* Get User's Rank by user identifier. Min: 1
*
* @param userId - Unique User Identifier (ex: userId, username, email)
*/
Leaderboard.prototype.getRank = function (userId) {
return __awaiter(this, void 0, void 0, function () {
var rank;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.client.zrevrank(this.leaderboardId, userId)];
case 1:
rank = _a.sent();
return [2 /*return*/, rank == null || rank === undefined ? null : rank + 1];
}
});
});
};
/**
* It returns users between startRank [included] & endRank [included]
*
* Default: Returns whole leaderboard.
*
* @param startRank - Min: 1
* @param endRank
*/
Leaderboard.prototype.getListBetween = function (startRank, endRank) {
if (startRank === void 0) { startRank = 1; }
if (endRank === void 0) { endRank = 0; }
return __awaiter(this, void 0, void 0, function () {
var result;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.client.zrevrange(this.leaderboardId, startRank - 1, endRank - 1, "WITHSCORES")];
case 1:
result = _a.sent();
return [2 /*return*/, Leaderboard.zrevrangeResponse(result, startRank)];
}
});
});
};
Leaderboard.zrevrangeResponse = function (rangeResponse, startRank) {
var response = [];
var userIds = rangeResponse.filter(function (el, index) { return index % 2 === 0; });
var scores = rangeResponse.filter(function (el, index) { return index % 2 === 1; });
for (var i = 0; i < userIds.length; i++) {
response.push({
userId: userIds[i],
score: parseFloat(scores[i]),
rank: startRank + i,
});
}
return response;
};
return Leaderboard;
}());
exports.Leaderboard = Leaderboard;
//# sourceMappingURL=Leaderboard.js.map