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

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 })

Param	Type	Description
weight	`number`	User weight in kgs
height	`number`	User height in cms
age	`number`	User age
gender	`string`	User gender. Allowed values: 'man', 'woman'
exercise	`string`	User exercise. Allowed values: 'none', 'low', 'medium', 'high', 'extreme'

weight(weight)

Sets the user weight.

Param	Type	Description
weight	`number`	User weight

height(height)

Sets the user height.

Param	Type	Description
height	`number`	User height

age(age)

Sets the user age.

Param	Type	Description
age	`number`	User age

gender(gender)

Sets the user gender.

Param	Type	Description
gender	`string`	User gender. Allowed values: 'male', 'female'

exercise(exercise)

Sets the user exercise.

Param	Type	Description
exercise	`string`	User 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%',
}

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