Skip to content

@technobuddha > library > Math > Verbalization

Function: metricUnits()

ts
function metricUnits(input: number, options: MetricUnitsOptions): string;

Defined in: metric-units.ts:95

Abbreviate a number by adding a suffix for metric units (i.e. 1000 => 1K, .0001 = 1m)

Parameters

ParameterTypeDescription
inputnumberThe number to abbreviate
optionsMetricUnitsOptionsMetricUnitsOptions

Returns

string

Example

typescript
metricUnits(1000); // '1K'
metricUnits(1500); // '1.5K'
metricUnits(0.001); // '1m'
metricUnits(0.000001); // '1µ'
metricUnits(123456789); // '123.46M'
metricUnits(0); // '0'