UnitFormat.js Examples

A tiny JavaScript library for formatting numbers into human-readable metric units.

UnitFormat.js Demo

Number (num)

Base Unit (baseUnit)

Suffixes (suffixes)

Base (base)

Result:

12.345km

<script src="unitformat.min.js"></script>
<script>
  const formatted = UnitFormat(1000, "m"); // "1km"
</script>

import UnitFormat from 'unitformat';

const formatted = UnitFormat(20000, "Hz"); // "20kHz"

UnitFormat(1000) → "1k"

UnitFormat(0.02, "m") → "2cm"

UnitFormat(1048576, "B", "kMGTPE", 2) → "1MB"

UnitFormat(12345, "W", "kM") → "12.345kW"

UnitFormat(-5000000, "J") → "-5MJ"

UnitFormat(num, baseUnit, suffixes, base)

Parameter	Type	Default	Description
num	Number	-	The number to be formatted.
baseUnit	String	""	The base unit (e.g., "m", "Hz", "B").
suffixes	String	"kMGTPE"	A string of single-character metric prefixes to use.
base	Number	10	The number base, 10 for decimal or 2 for binary.