README

Awesome Converter

Awesome and typesafe unit converter

An awesome and typesafe unit converter for NodeJS

Install

Install with yarn:

$ yarn add awesome-converter

Usage

const {convert, definitions} = require('awesome-converter');
const {inspect} = require('util');
// Or for babel / typescript:
// import { convert, definitions } from 'awesome-querystring';
// import { inspect } from 'util'; ==> Note that this requires @types/node !!

// Just pass required arguments
// expected output: 0.22046244
console.log(convert(100, 'g', 'lb'));

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

// Will not work if you pass units of different groups
// expected error: Cannot convert incompatible unit of g to m
console.log(convert(100, 'g', 'm'));

// Log all supported definitions
console.log(inspect(definitions, {showHidden: false, depth: null}));

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

License

Buy me a donut

This project is open source and always will be, even if I don't get donations. That said, I know there are people out there that may still want to donate just to show their appreciation so this is for you guys. Thanks in advance!

I accept donations through PayPal, BitCoin, Ethereum and LiteCoin. You can use the buttons below to donate through your method of choice