Pacecal
A npm package to calculate pace using distance and time in various units.
Installation
npm
npm install pacecal
Browser
CDN
download package
Usage
Import the package
const Pace = ;
Creating Pace object
Class parameters
- distance - default unit: km
- time - default unit: s
- optional params
- distanceUnit - unit of distance
- timeUnit - unit of time
// using default distance unit: km, default time unit: sconst pace = 10 3600;
// overriding default unitsconst pace = 62 60 distanceUnit: 'mi' timeUnit: 'min' ; //distance: 6.2 miles, time: 60 min
// for browsers using CDN build use module name: pacecalconst pace = 10 60 distanceUnit: 'km' timeUnit: 'min' ;
Available methods
-
.getPace();
// returns pace in s/kmpace; -
.getPaceTimeString();
// returns time taken for 1 km in hh:mm:ss formatpace; -
.format('mi', 'min')
// returns pace in min/mipace;// returns time taken for 1 mile in hh:mm:ss formatpace;
Examples
// get pace in different units from distance in km and time in minsconst pace = 10 60 distanceUnit: 'km' timeUnit: 'min' ; // get pace in s/kmpace; // 360// time taken for one km in hh:mm:ss formatpace; // 00:06:00 // get pace in min/mipace; // 9.656039999999999// time taken for one mile in hh:mm:ss formatpace; // 00:09:39 // get pace in min/kmpace; // 6// time taken for one km in hh:mm:ss formatpace; // 00:06:00
Units supported
Distance
- m - metre
- km - kilometers
- mi - miles
Time
- ms - milliseconds
- s - seconds
- min - minutes
- h - hours
Deprecated functions
const pacecal = ; // accepts input in km and seconds only // returns time taken in hh:mm:ss format to cover one kmpacecal; // 00:06:00 // returns pace in seconds/kmpacecal; // 360 // returns average of all the pace valuespacecal; // 372 // returns average time taken in hh:mm:ss format to cover one kmpacecal;
License
This project is licensed under the MIT License - see the LICENSE file for details