Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/wanadev/tinu
Browse files Browse the repository at this point in the history
  • Loading branch information
clementlevasseur committed Dec 2, 2016
2 parents 843a9a1 + 38ca36d commit 773a921
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,39 +19,39 @@ or clone:
Conversion function returns an object that contain the parsed and NORMALIZED value/unit AND some function described bellow :

```javascript
unitConvert.distance(12); // → {value: 12, unit: "cm", ...}
unitConvert.distance(12, "mm"); // → {value: 12, unit: "mm", ...}
unitConvert.distance(12, "in"); // → {value: 12, unit: "in", ...}
unitConvert.distance(12, "inch"); // → {value: 12, unit: "in", ...}
unitConvert.distance("12m"); // → {value: 12, unit: "m", ...}
unitConvert.distance("12 m"); // → {value: 12, unit: "m", ...}
unitConvert.distance("12.00m"); // → {value: 12, unit: "m", ...}
tinu.distance(12); // → {value: 12, unit: "cm", ...}
tinu.distance(12, "mm"); // → {value: 12, unit: "mm", ...}
tinu.distance(12, "in"); // → {value: 12, unit: "in", ...}
tinu.distance(12, "inch"); // → {value: 12, unit: "in", ...}
tinu.distance("12m"); // → {value: 12, unit: "m", ...}
tinu.distance("12 m"); // → {value: 12, unit: "m", ...}
tinu.distance("12.00m"); // → {value: 12, unit: "m", ...}

unitConvert.area(80, "m2"); // → {value: 80, unit: "m2", ...}
```

The .to() method converts to the same object but in the requested unit.

```javascript
unitConvert.distance(12).to("m"); // → {value: 0.012, "m", ...}
unitConvert.distance(12).to("meter"); // → {value: 0.012, "m", ...}
unitConvert.distance(12).to("m").to("mm"); // → {value: 120, "mm", ...}
unitConvert.distance(12).to(); // → converts to the default target unit: {value: 0.012, "m", ...}
tinu.distance(12).to("m"); // → {value: 0.012, "m", ...}
tinu.distance(12).to("meter"); // → {value: 0.012, "m", ...}
tinu.distance(12).to("m").to("mm"); // → {value: 120, "mm", ...}
tinu.distance(12).to(); // → converts to the default target unit: {value: 0.012, "m", ...}
```

The .toNumber(unit=null) method converts to a Number in the requested unit

```javascript
unitConvert.distance(12).toNumber("m"); // → 0.012
unitConvert.distance(12).toNumber(); // → converts to the default target unit: 0.012
tinu.distance(12).toNumber("m"); // → 0.012
tinu.distance(12).toNumber(); // → converts to the default target unit: 0.012
```

The .toString(unit=null, numericScale=null) method converts to a String in the requested unit, that includes the unit

```javascript
unitConvert.distance(12, "cm").toString("m"); // → "0.012 m"
unitConvert.distance(12, "cm").toString("m", 2); // → "0.01 m"
unitConvert.distance(12, "cm").toString(); // → converts to the default target unit: "0.012 m"
tinu.distance(12, "cm").toString("m"); // → "0.012 m"
tinu.distance(12, "cm").toString("m", 2); // → "0.01 m"
tinu.distance(12, "cm").toString(); // → converts to the default target unit: "0.012 m"
```

Please help yourself to add type and other unit if needed !

0 comments on commit 773a921

Please sign in to comment.