split-tracker
Version:
A simple JS library for calculating running track split times.
129 lines (82 loc) • 2.42 kB
Markdown
A simple JS library for calculating running track split times.
Install with npm:
```
$ npm install split-tracker --save
```
with yarn:
```
$ yarn add split-tracker
```
or add it directly to your webpage using a CDN:
```html
<head>
<script src="https://cdn.jsdelivr.net/npm/split-tracker@1.0.8/dist/index.min.js"></script>
</head>
```
if you are working off an older version of the CDN, simply replace split-tracker@X.X.X with a more precise version
```javascript
const splitTracker = require('split-tracker');
splitTracker.calculateSplitByMileTime(6, 200);
```
```javascript
import { calculateSplitByMileTime, calculateSplitByKilometerTime } from 'split-tracker';
splitTracker.calculateSplitByMileTime(6, 200);
splitTracker.calculateSplitByKilometerTime('3:30', 400);
```
Using the CDN:
```html
<html>
<head>
<script src="https://cdn.jsdelivr.net/npm/split-tracker@1.0.8/dist/index.min.js"></script>
</head>
</head>
// inside of js file (or script tag)
document.querySelector("body").onload = function() {
var split = splitTracker.calculateSplitByMileTime(6, 200);
console.log('split: ', split);
}
```
```javascript
const seconds = 6.5;
convertSecondsToMMSS(seconds) // => '6:30'
```
```javascript
const time = '15:30';
convertMMSSToSeconds(time); // => 930 (seconds)
```
```javascript
const minutes = 1.512;
convertMinutesInDecimalsToMMSS(minutes); // => 1:31
```
```javascript
const mileTime = '6:00';
// may be a formatted string (mm:ss) or a valid number (e.g. 6 or 6.0)
const splitDistance = 200;
// must be a valid number in meters
calculateSplitByMileTime(mileTime, splitDistance);
// => { precise_split: 44.74, formatted_split: ':45' }
// yields both the precise_split time in seconds and a rounded, formatted split in MM:SS
```
```javascript
const kilometerTime = '3:30';
// may be a formatted string (mm:ss) or a valid number (e.g. 3.5)
const splitDistance = 5000;
// must be a valid number in meters
calculateSplitByKilometerTime(kilometerTime, splitDistance);
// => { precise_split: 1050, formatted_split: '17:30' }
// yields both the precise_split time in seconds and a rounded, formatted split in MM:SS
```