formatSize

Format a byte count into a human-readable string with the appropriate unit.

Each unit is 1024 of the previous (binary prefix). The result is formatted with one decimal place, unless integerBelowFirstUnit is set.

Available since v2.0.0

Import

import { formatSize } from '@helpers4/number';
// or, from the all-in-one package (same code, one install):
import { formatSize } from 'helpers4/number';

Signature

formatSize(bytes: number, options: FormatSizeOptions): string

Parameters

Parameter	Type	Description
bytes	number	A non-negative integer representing a byte count.
options	FormatSizeOptions	Options.

Returns

string — A human-readable string such as '0.0B', '1.5KB', '3.2MB'.

Examples

Format bytes to human-readable size

Converts a raw byte count to a human-readable string using binary prefixes.

formatSize(0)             // '0.0B'
formatSize(512)           // '512.0B'
formatSize(1024)          // '1.0KB'
formatSize(1_048_576)     // '1.0MB'
formatSize(1_073_741_824) // '1.0GB'

Space before the unit, and a bare integer below the first unit

unitSeparator inserts a separator before the unit; integerBelowFirstUnit drops the decimal for byte counts under 1024.

formatSize(1536, { unitSeparator: ' ' })                            // '1.5 KB'
formatSize(512, { integerBelowFirstUnit: true })                    // '512B'
formatSize(512, { unitSeparator: ' ', integerBelowFirstUnit: true }) // '512 B'

Related Types

FormatSizeOptions

Options for formatSize.

interface FormatSizeOptions {
  integerBelowFirstUnit?: boolean;
  unitSeparator?: string;
}

Source

View source on GitHub