unit-converter-package-roshan

A lightweight, type-safe unit conversion utility for JavaScript and TypeScript projects.

Supports length and temperature conversions with zero dependencies and full tree-shaking support.

---

✨ Features

- 📏 Length conversion (cm, m, km)
- 🌡️ Temperature conversion (celsius, fahrenheit, kelvin)
- ⚡ Fast and lightweight
- 🧠 Fully typed (TypeScript)
- 🌳 Tree-shakeable
- 🚫 No external dependencies
- 🧪 Tested with Jest

---

📦 Installation

``bash
npm install unit-converter-package-roshan
``

or

`bash
yarn add unit-converter-package-roshan
`

---

🚀 Usage

$3

`ts
import {
convertLength,
convertTemperature,
LengthUnit,
TemperatureUnit
} from "unit-converter-package-roshan";
`

---

📏 Length Conversion

$3

* cm
* m
* km

$3

`ts
convertLength(100, "cm", "m"); // 1
convertLength(2, "km", "m"); // 2000
convertLength(1500, "m", "km"); // 1.5
`

$3

`ts
const unit: LengthUnit = "cm"; // ✅
const wrongUnit: LengthUnit = "mm"; // ❌ TypeScript error
`

---

🌡️ Temperature Conversion

$3

* celsius
* fahrenheit
* kelvin

$3

`ts
convertTemperature(0, "celsius", "fahrenheit"); // 32
convertTemperature(32, "fahrenheit", "celsius"); // 0
convertTemperature(0, "celsius", "kelvin"); // 273.15
`

$3

For temperature conversions, floating-point math is used.
Use rounding if required:

`ts
const value = convertTemperature(32, "fahrenheit", "kelvin");
value.toFixed(2); // "273.15"
`

---

🧠 API Reference

$3

`ts
convertLength(
value: number,
from: LengthUnit,
to: LengthUnit
): number
`

---

$3

`ts
convertTemperature(
value: number,
from: TemperatureUnit,
to: TemperatureUnit
): number
`

---

🧪 Testing

This package is tested using Jest.

`bash
npm test
`

---

🌳 Tree Shaking

This package uses ES Modules and supports tree-shaking:

`ts
import { convertLength } from "unit-converter-package-roshan";
`

Unused functions are excluded from the final bundle.

---

🛠️ Built With

* TypeScript
* Jest
* Zero runtime dependencies

---

🧩 Roadmap

Planned enhancements:

* Weight units (g, kg, lb)
* Time units (s, min, hr)
* Speed units (m/s, km/h`)
* Chainable API
* Optional rounding helpers

---

🤝 Contributing

Pull requests are welcome.

1. Fork the repository
2. Create a feature branch
3. Add tests for your changes
4. Submit a pull request

---

📄 License

MIT License © Roshan

---