Socket
Book a DemoInstallSign in
Socket

toefungi-elo-calculator

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

toefungi-elo-calculator

A package to do all necessary computations to determine ELO rankings

1.3.4
latest
npmnpm
Version published
Weekly downloads
2
-71.43%
Maintainers
1
Weekly downloads
 
Created
Source

ELO Calculator

Build Status Quality Gate Status Bugs Code Smells Coverage

This package makes using the ELO ranking system easy. To get started you just need to decide what you want your starting ELO. After that, you can start calculating win probabilities based on two player's ELO scores and also determining the ELO of a player after a match.

It's very simple.

Installation

To install this package.

npm i toefungi-elo-calculator

Usage

You're first going to want to import the relevant files and instantiate a new instance of the EloCalculator.

import { EloCalculator } from 'toefungi-elo-calculator'

const eloCalculator: EloCalculator = new EloCalculator()

Here is a basic example of calculating a new ELO value.

import { ScoringBonus } from 'toefungi-elo-calculator'

// Declared player variables
const playerElo = 2149
const opponentElo = 2084

// Calculate ELO based on the outcome of the game without taking into account 
// Player performance or the score difference in the game
eloCalculator.calculateElo(playerElo, opponentElo, ScoringBonus.WIN)
  .then((elo: number) => {
    console.log(elo) // The new ELO
  })
  
// Take into account the numerical difference in the score to determine the ELO
// This will make the ELO change more dynamic as it computes slightly differently
// And will more accurately split the higher players from the lower players
// In terms of their ELO
const scoreDiff = 4

eloCalculator.calculateElo(playerElo, opponentElo, ScoringBonus.WIN, scoreDiff)
  .then((elo: number) => {
    console.log(elo) // The new ELO
  })

Here is a basic example of calculating win probabilities between two players.

import { Probabilities } from 'toefungi-elo-calculator'

// Declared player variables
const playerElo = 2149
const opponentElo = 2084

// Calculate ELO based on the outcome of the game
eloCalculator.caluclateWinProbability(playerElo, opponentElo)
  .then((probability: Probabilities) => {
    console.log(probability.player) // Probability player will win
    console.log(probability.opponent) // Probability opponent will win
  })

Testing

This package includes unit tests which cover 100% of the code and all tests are working. The testing framework being used is mocha and using chai-as-promisedto test the promise returns from the package.

The test suite can be run using the conventional npm test

The package uses nyc for code coverage.

Keywords

ELO

FAQs

Package last updated on 15 Jan 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.