Merge pull request #16 from pranavacharya/development

Added support for milliseconds and metre

README.md

@@ -6,19 +6,14 @@ A npm package to calculate pace using distance and time in various units.
 ![GitHub](https://img.shields.io/github/license/pranavacharya/pacecal)
 ![npm](https://img.shields.io/npm/v/pacecal)
 
-
-
-
 ## Installation
 
-
 ### npm
 
 ```sh
 npm install pacecal
 ```
 
-
 ### Browser
 
 #### CDN
@@ -29,21 +24,16 @@ npm install pacecal
 
 #### [download package](https://unpkg.com/pacecal@latest/dist/pacecal.umd.js)
 
-
-
 ## Usage
 
-
 #### Import the package
+
 ```javascript
 const { Pace } = require('pacecal');
 ```
 
-
-
 #### Creating Pace object
 
-
 ##### Class parameters
 
 1. distance - default unit: km
@@ -67,23 +57,24 @@ const pace = new Pace(6.2, 60, { distanceUnit: 'mi', timeUnit: 'min' }); //dista
 const pace = new pacecal.Pace(10, 60, { distanceUnit: 'km', timeUnit: 'min' });
 ```
 
-
 ##### Available methods
-* `.getPace();`
-   ```javascript
-   // returns pace in s/km
-   pace.getPace(); 
-   ```
-* `.getPaceTimeString();`
-   ```javascript
-   // returns time taken for 1 km in hh:mm:ss format
-   pace.getPaceTimeString();
-   ```
-* `.format('mi', 'min')`
+
+- `.getPace();`
+  ```javascript
+  // returns pace in s/km
+  pace.getPace();
+  ```
+- `.getPaceTimeString();`
+  ```javascript
+  // returns time taken for 1 km in hh:mm:ss format
+  pace.getPaceTimeString();
+  ```
+- `.format('mi', 'min')`
+
   ```javascript
   // returns pace in min/mi
   pace.format('mi', 'min').getPace();
-  
+
   // returns time taken for 1 mile in hh:mm:ss format
   pace.format('mi', 'min').getPaceTimeString();
   ```
@@ -110,20 +101,22 @@ pace.format('km', 'min').getPace(); // 6
 pace.format('km', 'min').getPaceTimeString(); // 00:06:00
 ```
 
-
 ## Units supported
 
 ##### Distance
-* km - kilometers
-* mi - miles
+
+- m - metre
+- km - kilometers
+- mi - miles
 
 ##### Time
-* s - seconds
-* min - minutes
-* hr - hours
 
+- ms - milliseconds
+- s - seconds
+- min - minutes
+- hr - hours
 
-### ***Deprecated functions***
+### **_Deprecated functions_**
 
 ```javascript
 const pacecal = require('pacecal');
@@ -143,8 +136,6 @@ pacecal.getAreragePace([360, 366, 390]); // 372
 pacecal.getAreragePaceinTime([360, 366, 390]);
 ```
 
-
-
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

src/lib/distance.js

@@ -1,4 +1,8 @@
 const units = {
+  m: {
+    ratio: 0.001,
+    name: 'metre'
+  },
   mi: {
     ratio: 1.60934,
     name: 'miles'

src/lib/pace.js

@@ -23,10 +23,10 @@ export default class Pace {
    * @param {Object} [optional] - optional params
    * @param {String} [optional.distanceUnit] - unit of distance
    * - default unit: km
-   * - available units: "km", "mi"
+   * - available units: "m", "km", "mi"
    * @param {String} [optional.timeUnit] - unit of time
    * - default unit: s
-   * - available units: "s", "min" , "h"
+   * - available units: "ms", "s", "min" , "h"
    */
   constructor(
     distance = throwParamRequiredError('distance'),
@@ -71,10 +71,12 @@ export default class Pace {
    * - default unit - s/km
    * @param {string} distanceUnit
    *  Available units
+   * - m
    * - km
    * - mi
    * @param {string} timeUnit
    *  Available units
+   * - ms
    * - s
    * - min
    * - h

src/lib/time.js

@@ -1,4 +1,8 @@
 const units = {
+  ms: {
+    ratio: 0.001,
+    name: 'miliseconds'
+  },
   s: {
     ratio: 1,
     name: 'seconds'

tests/distance.test.js

@@ -3,10 +3,14 @@ import { listUnit, convertUnit } from '../src/lib/distance';
 describe('Distance', () => {
   test('list units', () => {
     expect(typeof listUnit()).toBe('object');
-    expect(listUnit()).toEqual(['mi', 'km']);
+    expect(listUnit()).toEqual(['m', 'mi', 'km']);
   });
 
-  test('convertUnit', () => {
+  test('convertUnit - km to mi', () => {
     expect(convertUnit(10, 'km', 'mi')).toBeCloseTo(6.2, 1);
   });
+
+  test('convertUnit - km to m', () => {
+    expect(convertUnit(10, 'km', 'm')).toBe(10000);
+  });
 });

tests/pacecal.test.js

@@ -51,7 +51,7 @@ describe('Pace Class', () => {
     expect(() => {
       // invalid distanceUnit
       // eslint-disable-next-line no-unused-vars
-      const pace = new Pace(6, 3600, { distanceUnit: 'm', timeUnit: 'min' });
+      const pace = new Pace(6, 3600, { distanceUnit: 'yard', timeUnit: 'min' });
     }).toThrow(TypeError);
   });
 

tests/time.test.js

@@ -3,10 +3,14 @@ import { listUnit, convertUnit } from '../src/lib/time';
 describe('Time', () => {
   test('list units', () => {
     expect(typeof listUnit()).toBe('object');
-    expect(listUnit()).toEqual(['s', 'min', 'h']);
+    expect(listUnit()).toEqual(['ms', 's', 'min', 'h']);
   });
 
-  test('convertUnit', () => {
+  test('convertUnit - min to s', () => {
     expect(convertUnit(60, 'min', 's')).toBe(3600);
   });
+
+  test('convertUnit - min to ms', () => {
+    expect(convertUnit(60, 'min', 'ms')).toBe(3600000);
+  });
 });