Comparing version 1.0.1 to 2.0.0
{ | ||
"name": "531", | ||
"version": "1.0.1", | ||
"version": "2.0.0", | ||
"description": "Given a 1RM, generate a 4 week 5/3/1 cycle", | ||
"main": "./src", | ||
"main": "index.js", | ||
"scripts": { | ||
"test": "istanbul cover _mocha -- ./test" | ||
"test": "standard && tape test.js" | ||
}, | ||
@@ -24,10 +24,14 @@ "repository": { | ||
"dependencies": { | ||
"round": "~1.0.0", | ||
"ap": "~0.2.0", | ||
"round": "~2.0.0", | ||
"xtend": "~4.0.0" | ||
}, | ||
"devDependencies": { | ||
"chai": "~1.10.0", | ||
"istanbul": "~0.3.2", | ||
"mocha": "~2.0.1" | ||
} | ||
"standard": "~4.5.2", | ||
"tape": "~4.0.0" | ||
}, | ||
"files": [ | ||
"index.js", | ||
"program.json" | ||
] | ||
} |
@@ -1,40 +0,88 @@ | ||
531.js | ||
531.js [](https://travis-ci.org/bendrucker/531.js) | ||
====== | ||
Given a 1RM, generate a 4 week 5/3/1 cycle. | ||
> Given a one rep max, generate a 4 week 5/3/1 cycle. | ||
## Setup | ||
```bash | ||
$ npm install 531 | ||
## Install | ||
```sh | ||
npm install --save 531 | ||
``` | ||
## Usage | ||
```js | ||
var fto = require('531') | ||
var cycle = fto(455) | ||
// first week, first set weight: | ||
// => cycle[0][0].weight | ||
``` | ||
## API | ||
#### `fto(max, [options])` -> `Array` | ||
#### `fto(max, [options])` -> `array` | ||
Given a `max` (Number), generates an array of weeks. Each week has: | ||
Returns an array (of length 4) of set arrays (each of length 3). | ||
* `name`: The name of the week, e.g. "Week 1" | ||
* `sets`: An `Array` of sets | ||
Each set has: | ||
* `ratio`: (Number) The ratio of the 90% 1RM to use for that set | ||
* `repetitions`: (Number) The number of repetitions to perform | ||
* `weight`: (Number) The total weight to use | ||
* `max`: (Boolean) Whether that set should be performed for the maximum number of sets possible | ||
###### ratio | ||
`options` may contain: | ||
Type: `number` | ||
* `round`: Defaults to `'down'`. Set to `'up'` to round up to the nearest increment | ||
* `increment`: Defaults to `5`. Sets the increment to use when rounding weights. | ||
* `use90`: Defaults to `true`. Set to `false` to use 100% of your 1RM for calculations. | ||
The ratio of the 90% 1RM to use for that set. | ||
## Example | ||
###### repetitions | ||
```js | ||
var fto = require('531'); | ||
var cycle = fto(455); | ||
Type: `number` | ||
console.log('Next cycle, my first deadlift will be:', cycle[0].sets[0].weight, 'lbs'); | ||
``` | ||
The number of repetitions to perform. | ||
###### weight | ||
Type: `number` | ||
The total weight to use (unitless). | ||
##### max | ||
Type: `boolean` | ||
Whether that set should be performed for the maximum number of sets possible. | ||
--- | ||
##### max | ||
*Required* | ||
Type: `number` | ||
Your estimated one rep max to use. | ||
##### options | ||
###### round | ||
Type: `string` | ||
Default: `'down'` | ||
The direction to round weights to. | ||
###### increment | ||
Type: `number` | ||
Default: `5` | ||
The increment to use when rounding weights. | ||
###### use90 | ||
Type: `boolean` | ||
Default: `true` | ||
Set to `false` to use 100% of your estimated one rep max for calculations instead of the recommended 90%. | ||
## License | ||
MIT © [Ben Drucker](http://bendrucker.me) |
Sorry, the diff of this file is not supported yet
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
2
89
4524
3
5
83
1
+ Addedap@~0.2.0
+ Addedap@0.2.0(transitive)
+ Addedis-finite@1.0.2(transitive)
+ Addedis-integer@1.0.7(transitive)
+ Addednumber-is-nan@1.0.1(transitive)
+ Addedparse-exponential@1.0.1(transitive)
+ Addedprecision@1.0.1(transitive)
+ Addedround@2.0.1(transitive)
+ Addedround-precision@1.0.0(transitive)
- Removedround@1.0.1(transitive)
Updatedround@~2.0.0