@arraypress/unit-converter

Weight and dimension unit conversion with formatting. Zero dependencies.

Works in Node.js, Cloudflare Workers, Deno, Bun, and browsers.

Install

npm install @arraypress/unit-converter

Weight Conversion

Canonical unit: grams. Supported: g, kg, oz, lb.

toGrams(value, unit?)

Convert a weight value to grams.

import { toGrams } from '@arraypress/unit-converter';

toGrams(1, 'kg')   // 1000
toGrams(1, 'lb')   // 453.592
toGrams(16, 'oz')  // 453.592
toGrams(500)       // 500 (default: grams)

fromGrams(grams, unit?)

Convert grams to another unit.

import { fromGrams } from '@arraypress/unit-converter';

fromGrams(1000, 'kg')  // 1
fromGrams(453.592, 'lb')  // 1

convertWeight(value, fromUnit, toUnit)

Convert between any two weight units.

import { convertWeight } from '@arraypress/unit-converter';

convertWeight(1, 'kg', 'lb')  // 2.20462
convertWeight(16, 'oz', 'lb') // ~1

formatWeight(grams, unit?, decimals?)

Format a weight value stored in grams as a human-readable string.

import { formatWeight } from '@arraypress/unit-converter';

formatWeight(500, 'g')       // '500g'
formatWeight(1500, 'kg')     // '1.5kg'
formatWeight(1000, 'kg', 0)  // '1kg'

Dimension Conversion

Canonical unit: centimeters. Supported: cm, in, mm, m.

toCm(value, unit?)

Convert a dimension value to centimeters.

import { toCm } from '@arraypress/unit-converter';

toCm(1, 'in')  // 2.54
toCm(1, 'm')   // 100
toCm(10, 'mm') // 1
toCm(50)       // 50 (default: cm)

fromCm(cm, unit?)

Convert centimeters to another unit.

import { fromCm } from '@arraypress/unit-converter';

fromCm(2.54, 'in')  // 1
fromCm(100, 'm')    // 1
fromCm(1, 'mm')     // 10

convertDimension(value, fromUnit, toUnit)

Convert between any two dimension units.

import { convertDimension } from '@arraypress/unit-converter';

convertDimension(1, 'in', 'cm')    // 2.54
convertDimension(25.4, 'mm', 'in') // 1

formatDimension(cm, unit?, decimals?)

Format a dimension value stored in cm as a human-readable string.

import { formatDimension } from '@arraypress/unit-converter';

formatDimension(50, 'cm')      // '50cm'
formatDimension(2.54, 'in')    // '1in'

formatDimensions(length, width, height, unit?, decimals?)

Format three dimensions (L x W x H) stored in cm.

import { formatDimensions } from '@arraypress/unit-converter';

formatDimensions(30, 20, 10, 'cm')        // '30 x 20 x 10 cm'
formatDimensions(25.4, 12.7, 5.08, 'in')  // '10 x 5 x 2 in'

Constants

import { WEIGHT_UNITS, DIMENSION_UNITS, WEIGHT_LABELS, DIMENSION_LABELS } from '@arraypress/unit-converter';

WEIGHT_UNITS     // ['g', 'kg', 'oz', 'lb']
DIMENSION_UNITS  // ['cm', 'in', 'mm', 'm']
WEIGHT_LABELS    // { g: 'Grams', kg: 'Kilograms', oz: 'Ounces', lb: 'Pounds' }
DIMENSION_LABELS // { cm: 'Centimeters', in: 'Inches', mm: 'Millimeters', m: 'Meters' }

License

MIT