@udlearn/convert

A CLI for unit conversion, powered by convert-units.

Install

npm install @udlearn/convert

To install the convert CLI globally:

npm install -g @udlearn/convert

CLI Usage

Usage
  convert <value> <from> <to>       Convert between units
  convert <value> <from>            Show table of all conversions

Commands
  convert measures                  List available measures
  convert list [measure]            List all units (optionally filtered by measure)
  convert options <unit>            List units a given unit can convert to
  convert describe <unit>           Describe a unit

Options
  -h, --help                        Show this help message
  -v, --version                     Print version
  --from <unit>                     Source unit
  --to <unit>                       Target unit
  --json                            Output conversion table as JSON

Examples

# Convert pounds to kilograms
convert 1 lb kg
# 0.45359237

# Show all conversions for a unit
convert 50 F
# 50 degrees Fahrenheit (F)
#
# +--------+------+-----------------+
# |  value | unit | name            |
# +--------+------+-----------------+
# |     10 | C    | degrees Celsius |
# | 283.15 | K    | Kelvins         |
# | 509.67 | R    | degrees Rankine |
# +--------+------+-----------------+

# Same, as JSON
convert 50 F --json
# { "C": 10, "K": 283.15, "R": 509.67 }

# List all mass units
convert list mass
#   mcg  Micrograms (metric)
#   mg   Milligrams (metric)
#   ...

# Show available measures
convert measures
# acceleration, angle, area, …

# What can kilometers convert to?
convert options km
# nm, μm, mm, cm, dm, m, km, mil, in, yd, ft-us, ft, fathom, mi, nMi

# Describe a unit
convert describe kg
# { "abbr": "kg", "measure": "mass", "system": "metric", … }

Development

During development you can run the CLI directly without linking:

node cli.js -h

Programmatic Usage

The package exports a pre-configured convert-units instance with all measures loaded:

import convert from '@udlearn/convert';

convert(1).from('lb').to('kg');       // 0.45359237
convert(72).from('F').to('C');        // 22.222…
convert(12000).from('mm').toBest();   // { val: 12, unit: 'm', … }

convert().measures();                 // ['acceleration', 'angle', …]
convert().from('km').possibilities(); // ['nm', 'μm', 'mm', …]
convert().describe('kg');             // { abbr, measure, system, … }

Supported Measures

This package includes all measures bundled with convert-units: length, mass, volume, temperature, time, digital, speed, frequency, and many more. See the full list of packaged units.

License

MIT