KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #codex #ai-agents #claude-code #dsh #dsh-plugin #cli #macos #ai-agent #deepseek-harness #open-source

units-converter

★ 52 Open GitHub ↗

A simple utility library to measure and convert between units

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Units Converter
A simple library to convert units. Heavily based on [convert-units](https://github.com/ben-ng/convert-units).

[![CircleCI](https://circleci.com/gh/nosferatoy/units-converter.svg?style=svg)](https://circleci.com/gh/nosferatoy/units-converter)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/145ef4b5949d4be78a2bf577f078be49)](https://www.codacy.com/app/nosferatoy/units-converter?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=nosferatoy/units-converter&amp;utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/145ef4b5949d4be78a2bf577f078be49)](https://www.codacy.com/app/nosferatoy/units-converter?utm_source=github.com&utm_medium=referral&utm_content=nosferatoy/units-converter&utm_campaign=Badge_Coverage)

An [example](https://github.com/mugrufis/units-converter-consumer) implementation of the library.

### Key Features
* Tree shakable.
* No dependencies.
* Build for es6, cmj and umd.
* Tested to 4 significant figures.

## Installation

```
npm install units-converter --save
```

## Usage

The library provide a simple chained API to transform units of the same type.
The units are broken down to modules, so it is possible and recommended, to load only the unite types that you are using.
```js
import { voltage } from 'units-converter';

voltage(1).from('V').to('mV').value;
//1000
```
or

```js
import * as converter from 'units-converter';

converter.voltage(1).from('V').to('mV').value;
//1000

converter.mass(1).from('lb').to('oz').value;
//16
```

* Convert unit will return an object of the unit specifed in the "to" function
```js
import { length } from 'units-converter';

length(1200).from('mm').to('m');
 /* {
      value: 1.2,
      unit: 'm',
      system: 'metric',
      singular: 'Meter',
      plural: 'Meters'
    } */
```
* Convert unit to Best
```js
import { length } from 'units-converter';

// the smallest unit with a value above 1
length(12000).from('mm').toBest();
/* {  
      value: 1.2,
      unit: 'm',
      system: 'metric',
      singular: 'Meter',
      plural: 'Meters'
    } */

// the smallest unit excluding meters
length(12000).from('mm').toBest({ exclude: ['m'] });
 /* {
      value: 1200,
      unit: 'cm',
      system: 'metric',
      singular: 'Centimeter',
      plural: 'Centimeters'
    } */

// the smallest unit with a value equal to or above 10
length(900).from('mm').toBest({ cutOffNumber: 10 });
 /* {
      value: 90,
      unit: 'cm',
      system: 'metric',
      singular: 'Centimeter',
      plural: 'Centimeters'
    } */
    
// the smallest unit with a value equal to or above 10
length(1000).from('mm').toBest({ cutOffNumber: 10 });
 /* {
      value: 100,
      unit: 'cm',
      system: 'metric',
      singular: 'Centimeter',
      plural: 'Centimeters'
    } */
```

* Possibilities will return an array with the abbreviations of the available units
```js
import { voltage } from 'units-converter';

voltage().from('V').possibilities();
// [ 'V', 'mV', 'kV' ]
```

* Describe will return an object with all the details of the unit
```js
import { voltage } from 'units-converter';

voltage().describe('V');

/* { 
      unit: 'V', 
      system: 'metric', 
      singular: 'Volt', 
      plural: 'Volts' 
    } */
```

* List will return and array with the description of all the available units
```js
import { voltage } from 'units-converter';

voltage().list();

/* [
    { 
      unit: 'V', 
      system: 'metric', 
      singular: 'Volt', 
      plural: 'Volts' 
    },
    {
      unit: 'mV',
      system: 'metric',
      singular: 'Millivolt',
      plural: 'Millivolts'
    },
    {
      unit: 'kV',
      system: 'metric',
      singular: 'Kilovolt',
      plural: 'Kilovolts'
    }
  ] */
```

## Units

<details><summary>Length</summary>

* mm
* cm
* m
* in
* ft-us
* ft
* fathom
* mi
* nMi
 

</details>

<details><summary>Area</summary>

 
* mm2
* cm2
* m2
* ha
* km2
* in2
* ft2
* ac
* mi2

</details>

<details><summary>Mass</summary>

 
* mcg
* mg
* g
* kg
* oz
* lb
* mt
* t

</details>

<details><summary>Volume</summary>

 
* mm3
* cm3
* ml
* l
* kl
* m3
* km3
* tsp
* Tbs
* in3
* fl-oz
* cup
* pnt
* qt
* gal
* ft3
* yd3

</details>

<details><summary>Volume Flow Rate</summary>

 
* mm3/s
* cm3/s
* ml/s
* cl/s
* dl/s
* l/s
* l/min
* l/h
* kl/s
* kl/min
* kl/h
* m3/s
* m3/min
* m3/h
* km3/s
* tsp/s
* Tbs/s
* in3/s
* in3/min
* in3/h
* fl-oz/s
* fl-oz/min
* fl-oz/h
* cup/s
* pnt/s
* pnt/min
* pnt/h
* qt/s
* gal/s
* gal/min
* gal/h
* ft3/s
* ft3/min
* ft3/h
* yd3/s
* yd3/min
* yd3/h'

</details>

<details><summary>Temperature</summary>

 
* C
* F
* K
* R

</details>

<details><summary>Time</summary>

 
* ns
* mu
* ms
* s
* min
* h
* d
* week
* month
* year

</details>

<details><summary>Frequency</summary>

 
* Hz
* mHz
* kHz
* MHz
* GHz
* THz
* rpm
* deg/s
* rad/s

</details>

<details><summary>Speed</summary>

 
* m/s
* km/h
* m/h
* knot
* ft/s

</details>

<details><summary>Pace</summary>

 
* s/m
* min/km
* s/ft
* min/km

</details>

<details><summary>Pressure</summary>

 
* Pa
* hPa
* kPa
* MPa
* bar
* torr
* psi
* ksi

</details>

<details><summary>Digital</summary>

 
* b
* Kb
* Mb
* Gb
* Tb
* B
* KB
* MB
* GB
* TB

</details>

<details><summary>Illuminance</summary>

 
* lx
* ft-cd

</details>

<details><summary>Parts-Per</summary>

 
* ppm
* ppb
* ppt
* ppq

</details>

<details><summary>Voltage</summary>

 
* V
* mV
* kV

</details>

<details><summary>Current</summary>

 
* A
* mA
* kA

</details>

<details><summary>Power</summary>

 
* W
* mW
* kW
* MW
* GW

</details>

<details><summary>Apparent Power</summary>

 
* VA
* mVA
* kVA
* MVA
* GVA

</details>

<details><summary>Reactive Power</summary>

 
* VAR
* mVAR
* kVAR
* MVAR
* GVAR

</details>

<details><summary>Energy</summary>

 
* Wh
* mWh
* kWh
* MWh
* GWh
* J
* kJ

</details>

<details><summary>Reactive Energy</summary>

 
* VARh
* mVARh
* kVARh
* MVARh
* GVARh

</details>

<details><summary>Angle</summary>

 
* deg
* rad
* grad
* arcmin
* arcsec

</details>

<details><summary>Charge</summary>

 
* c
* mC
* μC
* nC
* pC

</details>

<details><summary>Force</summary>

 
* N
* kN
* lbf

</details>

<details><summary>Acceleration</summary>

 
* g (g-force)
* m/s2

</details>

## Road map

* Add types to support better integration with typescript using projects.

* Add functionality for the addition of custom units.

* Add more units, the goal is to approach the amount of units provided by [matlab](https://www.mathworks.com/help/symbolic/units-list.html).

* Rewrite the project with typescript.

units-converter

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README