wilks/README.md

Calculate wilks score, dots, one rep max and more. Wilks formula and Dots are primarily used in powerlifting contests to identify the best lifter across different weight classes.

<div align="center">
  <h1>  
    <a href="https://www.npmjs.com/package/wilks">Wilks Calculator</a>
  </h1>
  <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/wilks">
  <img alt="NPM Version" src="https://img.shields.io/npm/v/wilks">
</div>

<br />

Calculate wilks score. Wilks formula is primarily used in powerlifting contests to identify the best lifter across different weight classes.

## 🚀 Quick Start

```sh
npm i wilks
```

```ts
import { wilks, wilks2020 } from "wilks";

const calculateWilks = wilks({ total: 612.5, bodyweight: 56, gender: "female", unit: "kg" }); // 720.67
const calculateWilks2020 = wilks2020({ total: 612.5, bodyweight: 56, gender: "female", unit: "kg" }); // 847.27
```

## ⭐ Usage

The module currently exports `"wilks"` and `"wilks/helpers"`. You can check the [tests](./src/__tests__) to see more examples.

### `wilks`

```ts
import { wilks, wilks2020, dots, ipf, ipfgl } from "wilks";

const input = {
  // Use total
  total: 612.5,
  // Or
  squat: 260,
  bench: 132.5,
  deadlift: 220,
  bodyweight: 56,
  gender: "female" | "male",
  unit: "kg" | "lb",
};

const calculateWilks
  = wilks({ total: 612.5, bodyweight: 56, gender: "female", unit: "kg" }); // 720.67
const calculateWilks2020
  = wilks2020({ squat: 260, bench: 132.5, deadlift: 220, bodyweight: 56, gender: "female", unit: "kg" }); // 847.27
const calculateDots
  = dots({ total: 612.5, bodyweight: 56, gender: "female", unit: "kg" }); // 709.96
// ipf(input, "clpl" | "clbp" | "eqpl" | "eqbp")
const calculateIpf
  = ipf({ total: 1350.4, bodyweight: 123.45, gender: "female", unit: "lb" }, "clpl"); // 1145.88
const calculateIpfGl
  = ipfgl({ total: 612.5, bodyweight: 56, gender: "female", unit: "kg" }, "clpl"); // 145.62
```

### `wilks/helpers`

Exports `roundToDecimal(input: number, decimal: number): number` and `convertWeight(weight: number, unit: "kg" | "lb", decimal = 1): number`.

```ts
import { roundToDecimal, convertWeight } from "wilks/helpers";

console.log(roundToDecimal(123.333, 2)); // 123.33
console.log(convertWeight(163.1, "lb")); // 74
console.log(convertWeight(163.1, "lb", 2)); // 73.98
```

## 📍 Roadmap

- [x] Wilks Formula 2020 Edition
- [x] Dots Calculator
- [x] IPF GL Points Calculator
- [ ] One Rep Max Calculator