Skip to content

Commit a3fc8dd

Browse files
committed
Updated README.md
1 parent aa4e0a8 commit a3fc8dd

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ uz('mile'); // implicit values (1)
2323
uz('4-5 seconds'); // parses ranges
2424
uz('4s - 3min'); // parses ranges with mixed units
2525
uz('2c, 4s, 23mi'); // mixed unit classes
26+
uz('23 m/s, 60 mph, 2 1/2 liters per second'); // rates
2627

2728
// Transformations
2829
uz('1.5 pints').normalize(); // = 3 cups: convert to unit in same class which is more human friendly
@@ -83,6 +84,12 @@ uz('(one and a half) acre'); // = 1 1/2acre
8384
uz('(12) tacos'); // = 12 tacos
8485
uz('1 (6 ounce)'); // = 6ounce
8586
uz('5 (3 liter)'); // = 15liter
87+
88+
// Rates (aliases)
89+
Unitz.Rates.addDefaults();
90+
91+
uz('60 mph');; // 60 miles/hour
92+
uz('23 knots');; // 23 nautical miles/hour
8693
```
8794
8895
### Customization
@@ -119,6 +126,9 @@ Unitz.Core.getGroup('cup').addUnits({
119126
// Remove some units from an existing group
120127
Unitz.Core.getGroup('c').removeUnits(['cup', 'cups']);
121128

129+
// Add my own rate
130+
Unitz.Rates.add('feet', 'second', ['fps']);
131+
122132
// Add my own class
123133
Unitz.Core.addClass(new Class('Loaf', [
124134
{

src/Rates.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export class Rates
4444
public static addDefaults()
4545
{
4646
this.add('miles', 'hour', ['mph']);
47-
this.add('nautical miles', 'hour', ['knot']);
47+
this.add('nautical miles', 'hour', ['knot', 'knots']);
4848
this.add('kilometers', 'hour', ['kph', 'kmph', 'km. hr.', 'k.p.h.', 'k.m.p.h.', 'km:h']);
4949
}
5050

0 commit comments

Comments
 (0)