Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brettlangdon/node-units
A extensible unit conversion library for Node.JS
https://github.com/brettlangdon/node-units
Last synced: 3 months ago
JSON representation
A extensible unit conversion library for Node.JS
- Host: GitHub
- URL: https://github.com/brettlangdon/node-units
- Owner: brettlangdon
- Created: 2013-02-18T22:43:36.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2016-01-29T14:09:39.000Z (almost 9 years ago)
- Last Synced: 2024-09-14T06:53:23.443Z (3 months ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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.
## Installing
```bash
npm install node-units
```
## Usage
### Functions
* `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
* `getUnitType(unit)` - given a single unit it will return back `{'type': , 'unit': , 'modifier': }`
* `convert(conversion_string)` - where `conversion_string` is of the form ` to `
### Properties
* `types` - `types` is an object containing constants for each unit group.
`types` with the default unit database looks like:
```javascript
{'TIME': 'time',
'VOLUME': 'volume'};
```
### Simple Usage
```javascript
var units = require('node-units');
var result = units.convert('5 gills to mL');
// result == 591.4705
units.convert('five days to seconds');
```
### Custom Units
With `node-units` you can import custom unit definitions from files defined like the following:
```
group:
longname,longname,ln 1ln
anotherunit,au 5ln
onemore,om 2au
```
```javascript
var units = require('node-units');
units.importDBSync('my_custom.units');
var result = units.convert('five au to onemores');
// result == 10
```
With custom units you can also overwrite any previously defined units.
```
time:
minute,m 50s
```
```javascript
var units = require('node-units');
units.importDBSync('my_custom.units');
var result = units.convert('5 minutes to s');
// result == 250
```
## Values
`node-units` uses `numberizer` which is used to convert string versions of numbers into digits, for example, `forty two` becomes `42` and `one fifth` becomes `0.2`.
What is currently not supported is mathematical symbols like `1/5 days`.
## Prefixes
`node-units` comes with a plethora of built in long and shortname unit prefixes like:
* nano-, n-
* micro-, mu-
* mega-
* giga-
* milli-, m-
* centi-, c-
* and others
## Variations
`node-units` also understands that it makes more sense to say things like `five days` rather than `five day` so when a unit is not know it will automatically look if the unit
ends with either `s`, `es` or `ies`.
## License
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.