node-units

Node.JS unit conversion library with customizable units

Node Units

A unit conversion library for Node.JS that comes with a default unit conversion database and the ability to extend the database with custom metrics.

npm install node-units
  • importDB(file_name, cb) - imports a custom unit database, cb takes a single argument err
  • importDBSync(file_name) - the sync version of importDB
  • getDB() - returns he currently used database of units as an object
  • convert(type, value, from, to) - converts value of from to to, returns the result or raises exception if conversion cannot be made
  • types - types is an object containing constants for each unit group.

types with the default unit database looks like:

{'TIME': 'time',
 'VOLUME': 'volume'};
var units = require('node-units');
 
var result = units.convert('volume', 5, 'gill', 'mL');
// result == 591.4705 
 
units.convert(units.types.TIME, 5, 'day', 'second');

With node-units you can import custom unit definitions from files defined like the following:

group:
  long_name,longname,ln    1ln
  another_unit,au          5ln
  one_more,om              2au
var units = require('node-units');
 
units.importDBSync('my_custom.units');
 
var result = units.convert(units.types.GROUP, 5, 'au', 'one_more');
// result == 10 

With custom units you can also overwrite any previously defined units.

time:
  minute,m      50s
var units = require('node-units');
 
units.importDBSync('my_custom.units');
 
var result = units.convert('time', 5, 'minute', 's');
// result == 250 

The MIT License (MIT) Copyright (c) 2013 Brett Langdon

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.