Skip to content

@technobuddha > library > Math > Verbalization

Function: binaryUnits()

ts
function binaryUnits(input: number, options: BinaryUnitsOptions): string;

Defined in: binary-units.ts:26

Abbreviate a binary number by adding a suffix for metric units (i.e. 1024 => 1KiB)

Parameters

ParameterTypeDescription
inputnumberThe number to abbreviate
optionsBinaryUnitsOptionssee BinaryUnitsOptions

Returns

string

Example

typescript
binaryUnits(1024); // '1KiB'
binaryUnits(1048576); // '1MiB'
binaryUnits(1536); // '1.5KiB'
binaryUnits(500); // '500B'
binaryUnits(0); // '0B'