Skip to content

@technobuddha > library > Math > Verbalization

Type Alias: MetricUnitsOptions

ts
type MetricUnitsOptions = {
  format?: string;
  macro?: ArrayLike<string>;
  micro?: ArrayLike<string>;
  pad?: number;
  precision?: number;
  unit?: number;
};

Defined in: metric-units.ts:52

Options for the metricUnits function w

Properties

PropertyTypeDescriptionDefined in
format?stringformat specification to pass to formatNumbersrc/metric-units.ts:56
macro?ArrayLike<string>Array of suffixes to use for large values (default: ['K', 'M', 'B', 'T', 'P', 'E', 'Z', 'Y'])src/metric-units.ts:64
micro?ArrayLike<string>Array of suffixed to use for small values (default: ['m', 'µ', 'n', 'p', 'f', 'a', 'z', 'y'])src/metric-units.ts:68
pad?numberleft padding to apply to numeric valuesrc/metric-units.ts:60
precision?numberNumber of digits after the decimal point to displaysrc/metric-units.ts:76
unit?numberMultiplier for each level of suffixes (default: 1000)src/metric-units.ts:72