Skip to content

Latest commit

 

History

History
103 lines (81 loc) · 3.16 KB

README.md

File metadata and controls

103 lines (81 loc) · 3.16 KB
one-rep-max

Calculate the maximum amount of force that can be generated in one maximal contraction


Built with ❤︎ by Tiaan du Plessis

Table of Contents

Table of Contents
  • Introduction
  • Install
  • Usage
  • CLI
  • Contribute
  • License
  • Introduction

    Greenkeeper badge

    This module provides various formulas for calculating one rep maximum based on a provided weight and number of repetitions.

    Install

    Install with npm

    $ npm install one-rep-max

    Install with yarn

    $ yarn add one-rep-max

    Usage

    To use, choose which formula to apply and provide an object with a weight & repetitions properties. You can read more about the available formulas here.

    const oneRepMax = require('one-rep-max')
    const args = {
      weight: 100,
      reps: 10
    }
    
    console.log(oneRepMax.epley(args)) // 133.33333333333331
    console.log(oneRepMax.brzycki(args)) // 133.33333333333331
    console.log(oneRepMax.mcGlothin(args)) // 134.0703628078088
    console.log(oneRepMax.lombardi(args)) // 125.89254117941672
    console.log(oneRepMax.oConner(args)) // 125

    CLI

    To use as a CLI tool, Install the module globally and run in the format:

    $ 1rm --method={all|epley||brzycki|mcGlothin|lombardi|oConner} --weight={quite obvious} --reps={quite obvious}

    For example:

    $ 1rm --method=all --weight=100 --reps=10
    # Outputs
    # epley - 133.33333333333331
    # brzycki - 133.33333333333331
    # mcGlothin - 134.0703628078088
    # lombardi - 125.89254117941672
    # oConner - 125

    Contributing

    All Contributions are welcome! Please open up an issue if you would like to help out. 😄

    License

    Licensed under the MIT License.

    Icon made by Darius Dan from www.flaticon.com is licensed by CC 3.0 BY