maegor

Unit conversion library

Install

$ npm install --save maegor

Examples

Converting Distances

const {Measurement, Length} = require('maegor');

let distance = new Measurement(58.7, Length.kilometers);

distance.convertedTo(Length.meters);  //=> '58700 m'
distance.convertedTo(Length.miles);   //=> '36.47457964134366 mi'
distance.convertedTo(Length.yards);   //=> '64195.10061242345 yd'

Converting Temperature

const {Measurement, Temperature} = require('maegor');

let temp = new Measurement(23.12, Temperature.celsius);
temp.convertedTo(Temperature.fahrenheit);  //=> '73.61599999999567 °F'

API

Measurement

• Measurement#canBeConvertedTo(unit): Check if a measurement can be converted to the specified unit
• Measurement#convertedTo(unit): Returns a new Measurement created by converting to the specified unit
• Measurement#convertTo(unit): Converts the measurement to the specified unit (In-Place)

Unit

Unit is the baseclass all dimensions (like Length or Mass) extend. You can define custom units either by extending a dimension's class or by using the API:

1. Defining custom units via the API:

// earth's radius is approx. 6371 meters
Length.addUnit('earthRadius', 'er', 6371);

let marathon = new Measurement(42.195, Length.kilometers);
marathon.convertTo(Length.earthRadius);  //=> '6.622979124156333 er'

2. Defining custom units via subclassing:

class LengthAdditions extends Length {
  static get earthRadius() {
    return new Length('er', 6371);
  }
}

let marathon = new Measurement(42.195, Length.kilometers);
marathon.convertTo(LengthAdditions.earthRadius); // //=> '6.622979124156333 er'

Unit.addUnit(name, symbol, converterOrCoefficient) -> Unit

Register a custom unit.

Note: This will throw an error if an unit with name already exists

Units

TODO

• Add methods to add, subtract, multiply and divide Measurement objects of the same Unit

License

MIT © Lukas Kollmer