JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q33173F
  • License Apache-2.0

Package Exports

  • macrouse

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (macrouse) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Macrouse

Installation

$ git clone git@github.com:socunanena/macrouse.git

Usage

Building the project

$ cd macrouse
$ yarn
$ yarn run build

Running the app

var Macrouse = require('./dist/index').default;

const subjectData = {
  weight: 70,
  height: 180,
  age: 38,
  gender: 'male',
};
const macrouse = new Macrouse(subjectData);

subjectData.bmr();

Documentation

Macrouse (class)

constructor({ weight, height, age, gender })

Param Type Description
weight Number Subject weight in kgs
height Number Subject height in cms
age Number Subject age
gender string Subject gender. Allowed values: 'man', 'woman'

bmr()

Gets the BMR (Basal Metabolic Rate) for the configured subject using the Harris-Benedict equation.

tee({ exercise })

Gets de TEE (Total Energy Expenditure) for the configured subject.

Param Type Description
exercise string Exercise factor

distributeMacros(macros)

Distributes the macros so that the total of the calories matches the calculated TEE.

Input data may have different formats. The user can provide:

  • The percentages for each macro to calculate the grams values. E.g.:
macros = {
  fat: '50%',
  protein: '20%',
  carbs: '30%',
}

or

macros = {
  fat: '70%',
  protein: '30%',
}
  • The value for one macro and the percentages for the remaining macros.
macros = {
  fat: '70%',
  protein: '30%',
  carbs: 50,
}
  • The value for two macros.
macros = {
  carbs: 30,
  protein: 140,
}
Param Type Description
macros Object
macros.fat Number | string Fat in grams or percentage
macros.protein Number | string Protein in grams or percentage
macros.carbs Number | string Carbs in grams or percentage