Merge pull request #6 from BlankRiser/new-units

Feature: Better unit returns and addition of pressure and energy units

Author: BlankRiser

apps/docs/package.json

@@ -11,7 +11,7 @@
   },
   "dependencies": {
     "@astrojs/starlight": "^0.35.2",
-    "@devhaven/unit-conversion": "0.0.6",
+    "@devhaven/unit-conversion": "workspace:*",
     "astro": "^5.6.1",
     "expressive-code-twoslash": "0.5.3",
     "sharp": "^0.34.2",

apps/docs/src/content/docs/api-reference.mdx

@@ -24,6 +24,7 @@ import { Conversion } from "@devhaven/unit-conversion";
 
 const conversion = new Conversion({ decimals: 4 });
 const result = conversion.value(10).from("meter").to("foot");
+//    ^?   
 ```
 
 ##### isFloat?: boolean
@@ -39,15 +40,3 @@ const conversion = new Conversion({ isFloat: true });
 const result = conversion.value(10).from("meter").to("foot");
 ```
 
-##### includeUnit?: boolean
-
-- Optional
-- Default: false
-- If true, the conversion result will include the unit as a string.
-
-```ts twoslash
-import { Conversion } from "@devhaven/unit-conversion";
-
-const conversion = new Conversion({ includeUnit: false });
-const result = conversion.value(10).from("meter").to("foot");
-```

apps/docs/src/content/docs/conversions/energy.mdx

@@ -0,0 +1,60 @@
+---
+title: "Energy"
+template: doc
+---
+
+The energy category supports conversions between Joule, Kilojoule, Calorie, Calorie (International Table), Calorie (Thermochemical), Watt-Hour, Kilowatt-Hour and Electron-Volt.
+
+## Supported Units
+
+- Joule `J`
+- Kilojoule `kJ`
+- Calorie `cal`
+- Calorie International Table `cal (IT)`
+- Calorie Thermochemical `cal (th)`
+- Watt-Hour `Wh`
+- Kilowatt-Hour `kWh`
+- Electron-Volt `eV`
+
+## Quick Example
+
+```ts
+import { Conversion } from "@devhaven/unit-conversion";
+
+const convert = new Conversion();
+
+convert.value(0).from("joule").to("kilojoule");      
+convert.value(212).from("kilojoule").to("joule");    
+```
+
+## Common Conversions
+
+### Joule ↔ Kilojoule
+```ts
+convert.value(1).from("joule").to("kilojoule");    
+convert.value(1).from("kilojoule").to("joule");      
+```
+
+### Joule ↔ Electron-Volt
+```ts
+convert.value(1).from("joule").to("electron-volt");    
+convert.value(1).from("electron-volt").to("joule");      
+```
+
+### Kilojoule ↔ Calorie
+```ts
+convert.value(1).from("kilojoule").to("calorie");     
+convert.value(1).from("calorie").to("kilojoule");      
+```
+
+### Calorie ↔ Electron Volt
+```ts
+convert.value(1).from("calorie").to("electron-volt");     
+convert.value(1).from("electron-volt").to("calorie");      
+```
+
+### Calorie ↔ Electron Volt
+```ts
+convert.value(1).from("calorie").to("electron-volt");     
+convert.value(1).from("electron-volt").to("calorie");      
+```

apps/docs/src/content/docs/conversions/length.mdx

@@ -9,8 +9,8 @@ This category is useful for engineering, construction, design, or any domain whe
 
 ## Supported Units
 
-- Metric: millimeter (mm), centimeter (cm), meter (m), kilometer (km)
-- Imperial / US: inch (in), foot (ft), yard (yd), mile (mi)
+- Metric: millimeter `mm`, centimeter `cm`, meter `m`, kilometer `km`
+- Imperial / US: inch `in`, foot `ft`, yard `yd`, mile `mi`
 
 ## Quick Example
 
@@ -44,36 +44,36 @@ convert.value(1).from("meter").to("foot");      // 3.28
 ### Meters ↔ Kilometers
 
 ```ts
-convert.value(1000).from("meter").to("kilometer");      // "1km"
-convert.value(2).from("kilometer").to("meter");         // "2000m"
+convert.value(1000).from("meter").to("kilometer");  
+convert.value(2).from("kilometer").to("meter");     
 ```
 
 ### Meters ↔ Feet
 
 ```ts
-convert.value(1).from("meter").to("foot");      // "3.28ft"
-convert.value(10).from("foot").to("meter");     // "3.05m"
+convert.value(1).from("meter").to("foot");  
+convert.value(10).from("foot").to("meter"); 
 ```
 
 ### Inches ↔ Centimeters
 
 ```ts
-convert.value(1).from("inch").to("centimeter");      // "2.54cm"
-convert.value(30).from("centimeter").to("inch");     // "11.81in"
+convert.value(1).from("inch").to("centimeter");  
+convert.value(30).from("centimeter").to("inch"); 
 ```
 
 ### Miles ↔ Kilometers
 
 ```ts
-convert.value(1).from("mile").to("kilometer");      // "1.609km"
-convert.value(5).from("kilometer").to("mile");      // "3.11mi"
+convert.value(1).from("mile").to("kilometer");  
+convert.value(5).from("kilometer").to("mile");  
 ```
 
 ### Yards ↔ Meters
 
 ```ts
-convert.value(1).from("yard").to("meter");      // "0.914m"
-convert.value(50).from("meter").to("yard");     // "54.68yd"
+convert.value(1).from("yard").to("meter");  
+convert.value(50).from("meter").to("yard"); 
 ```
 
 ## Configuration Options
@@ -86,8 +86,8 @@ import { Conversion } from "@devhaven/unit-conversion";
 const convert = new Conversion({
   decimals: 4,       // set precision
   isFloat: true,     // keep decimals or round
-  includeUnit: true, // whether to append unit symbol
 });
 
-console.log(convert.value(1).from("mile").to("kilometer"));      // "1.6093km"
+const { value, unit } = convert.value(1).from("mile").to("kilometer");  
+console.log(value, unit); 
 ```

apps/docs/src/content/docs/conversions/number.mdx

@@ -6,35 +6,39 @@ The **Number** category supports conversions between number bases such as binary
 
 ## Supported Bases
 
-- binary (base 2)
-- octal (base 8)
-- decimal (base 10)
-- hexadecimal (base 16)
+- binary `base 2`
+- octal `base 8`
+- decimal `base 10`
+- hexadecimal `base 16`
 
 
 ## Quick Example
-```ts
-console.log(convert.value(255).from("decimal").to("hexadecimal"));    // "ff"
 
-console.log(convert.value("1010").from("binary").to("decimal"));      // "10"
+```ts twoslash
+import { Conversion } from "@devhaven/unit-conversion";
+
+const convert = new Conversion();
+
+convert.value(255).from("decimal").to("hexadecimal")
+convert.value(1010).from("binary").to("decimal")
 ```
 
 ## Common Conversions
 
 ### Binary ↔ Decimal
 ```ts
-convert.value(10).from("decimal").to("binary");      // "1010"
-convert.value(10).from("binary").to("decimal");      // "1010"
+convert.value(10).from("decimal").to("binary");      
+convert.value(10).from("binary").to("decimal");      
 ```
 
 ### Decimal ↔ Hexadecimal
 ```ts
-convert.value("a").from("hexadecimal").to("decimal");     // "10"
-convert.value(15).from("decimal").to("hexadecimal");      // "f"
+convert.value("a").from("hexadecimal").to("decimal");     
+convert.value(15).from("decimal").to("hexadecimal");      
 ```
 
 ### Octal ↔ Decimal
 ```ts
-convert.value(77).from("octal").to("decimal");      // "63"
-convert.value(77).from("decimal").to("octal");      // "115"
+convert.value(77).from("octal").to("decimal");      
+convert.value(77).from("decimal").to("octal");      
 ```

apps/docs/src/content/docs/conversions/pressure.mdx

@@ -0,0 +1,45 @@
+---
+title: "Pressure"
+template: doc
+---
+
+The Pressure category supports conversions between Pascal, Kilopascal, Bar, PSI, and standard atmosphere.
+
+## Supported Units
+
+- Pascal `Pa`
+- Kilopascal `kPa`
+- Bar `bar`
+- PSI `psi`
+- Standard Atmosphere `atm`
+
+## Quick Example
+
+```ts
+import { Conversion } from "@devhaven/unit-conversion";
+
+const convert = new Conversion();
+
+convert.value(100).from("pascal").to("kilopascal");      
+convert.value(1).from("kilopascal").to("pascal");    
+```
+
+## Common Conversions
+
+### Pascal ↔ Bar
+```ts
+convert.value(1).from("pascal").to("bar");    
+convert.value(1).from("bar").to("pascal");      
+```
+
+### Kilopascal ↔ PSI
+```ts
+convert.value(1).from("kilopascal").to("psi");     
+convert.value(1).from("psi").to("kilopascal");      
+```
+
+### Bar ↔ PSI
+```ts
+convert.value(1).from("bar").to("psi");     
+convert.value(1).from("psi").to("bar");      
+```

apps/docs/src/content/docs/conversions/temperature.mdx

@@ -7,29 +7,32 @@ The Temperature category supports conversions between Celsius, Fahrenheit, and K
 
 ## Supported Units
 
-- celsius (°C)
-- fahrenheit (°F)
-- kelvin (K)
+- celsius `°C`
+- fahrenheit `°F`
+- kelvin `K`
 
 ## Quick Example
 
 ```ts
-console.log(convert.value(0).from("celsius").to("fahrenheit"));      // "32°F"
+import { Conversion } from "@devhaven/unit-conversion";
 
-console.log(convert.value(212).from("fahrenheit").to("celsius"));    // "100°C"
+const convert = new Conversion();
+
+convert.value(0).from("celsius").to("fahrenheit");      
+convert.value(212).from("fahrenheit").to("celsius");    
 ```
 
 ## Common Conversions
 
 
 ### Celsius ↔ Kelvin
 ```ts
-convert.value(100).from("celsius").to("kelvin");    // "373.15K"
-convert.value(0).from("kelvin").to("celsius");      // "-273.15°C"
+convert.value(100).from("celsius").to("kelvin");    
+convert.value(0).from("kelvin").to("celsius");      
 ```
 
 ### Celsius ↔ Fahrenheit
 ```ts
-convert.value(100).from("celsius").to("fahrenheit");     // "212°F"
-convert.value(32).from("fahrenheit").to("celsius");      // "0°C"
+convert.value(100).from("celsius").to("fahrenheit");     
+convert.value(32).from("fahrenheit").to("celsius");      
 ```

apps/docs/src/content/docs/conversions/time.mdx

@@ -6,41 +6,42 @@ The **time** category provides conversions between milliseconds, seconds, minute
 
 ## Supported Units
 
-- millisecond (ms)
-- second (s)
-- minute (min)
-- hour (h)
-- day (d)
+- millisecond `ms`
+- second `s`
+- minute `min`
+- hour `h`
+- day `d`
 
 ## Quick Example
 
 ```ts twoslash
 import { Conversion } from "@devhaven/unit-conversion";
 
 const convert = new Conversion();
-console.log(convert.value(60000).from("millisecond").to("minute"));      // "1min"
-console.log(convert.value(2).from("hour").to("minute"));                 // "120min"
+
+convert.value(60000).from("millisecond").to("minute");      
+convert.value(2).from("hour").to("minute");                 
 ```
 
 ## Common Conversions
 
 ### Day ↔ Hour
 
 ```ts
-convert.value(1).from("day").to("hour");        // "24h"
-convert.value(24).from("hour").to("day");       // "1d"
+convert.value(1).from("day").to("hour");        
+convert.value(24).from("hour").to("day");       
 ```
 
 ### Second ↔ Hour
 
 ```ts
-convert.value(3600).from("second").to("hour");      // "1h"
-convert.value(1).from("hour").to("second");         // "3600s"
+convert.value(3600).from("second").to("hour");      
+convert.value(1).from("hour").to("second");         
 ```
 
 ### Millisecond ↔ Second
 
 ```ts
-convert.value(1000).from("millisecond").to("second");      // "1s"
-convert.value(1).from("second").to("millisecond");         // "1000ms"
+convert.value(1000).from("millisecond").to("second");      
+convert.value(1).from("second").to("millisecond");         
 ```