2.1.0 • Published 6 years ago

macrouse v2.1.0

Weekly downloads
4
License
Apache-2.0
Repository
github
Last release
6 years ago

Installation

$ yarn add macrouse

Usage

Running the app

import Macrouse from 'macrouse';

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

const macros = {
  fat: '50%',
  protein: '20%',
  carbs: '30%',
};
macrouse.distributeMacros(macros);

Documentation

Macrouse (class)

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

ParamTypeDescription
weightnumberUser weight in kgs
heightnumberUser height in cms
agenumberUser age
genderstringUser gender. Allowed values: 'man', 'woman'
exercisestringUser exercise. Allowed values: 'none', 'low', 'medium', 'high', 'extreme'

weight(weight)

Sets the user weight.

ParamTypeDescription
weightnumberUser weight

height(height)

Sets the user height.

ParamTypeDescription
heightnumberUser height

age(age)

Sets the user age.

ParamTypeDescription
agenumberUser age

gender(gender)

Sets the user gender.

ParamTypeDescription
genderstringUser gender. Allowed values: 'male', 'female'

exercise(exercise)

Sets the user exercise.

ParamTypeDescription
exercisestringUser exercise. Allowed values: 'none', 'low', 'medium', 'high', 'extreme'

bmr()

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

tee()

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

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,
}
ParamTypeDescription
macrosObject
macros.fatnumber | stringFat in grams or percentage
macros.proteinnumber | stringProtein in grams or percentage
macros.carbsnumber | stringCarbs in grams or percentage
2.1.0

6 years ago

2.0.1

6 years ago

2.0.0

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago