Description

An awesome and typesafe unit converter for NodeJS

Key Features

• Typesafe
• Supports many different units
• Bundled with Rollup for maximum size reduction (only 1kB minified + gzipped!), ES module support and browser support
• Generated TypeScript declarations
• Treeshakeable in Webpack
• Useable in browsers

Install

Install with yarn or npm:

yarn add @favware/converter

# npm install @favware/converter

Usage

const { convert, definitions } = require('@favware/converter');
// import { convert, definitions } from '@favware/converter';

// Just pass required arguments
console.log(convert(100, 'g', 'lb')); // 0.22

// Specify decimal precision
console.log(convert(100, 'g', 'lb', { precision: 3 })); // 0.220

// Will not work if you pass units of different groups
console.log(convert(100, 'g', 'm')); // ConverterError: g and m and not in the same definition group

// Log all supported definitions
console.log(definitions);

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

Buy us some doughnuts

Favware projects are and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With	Address
GitHub Sponsors	Click Here
Ko-fi	Click Here
Patreon	Click Here
PayPal	Click Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jeroen Claassens 💻 🚇 📆 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!