Function formatBytes

Convert bytes to a human readable string: 1337 → 1.34 kB.

Example

import formatBytes from '@oliversalzburg/js-utils/format/bytes.js';

formatBytes(1337);
//=> '1.34 kB'

formatBytes(100);
//=> '100 B'

// Display file size differences
formatBytes(42, {signed: true});
//=> '+42 B'

// Localized output using German locale
formatBytes(1337, {locale: 'de'});
//=> '1,34 kB'

formatBytes(number: number, options?: Readonly<FormatBytesOptions>): string
Parameters
- number: number
  The number to format.
- options: Readonly<FormatBytesOptions> = ...
  The options for formatting the number.
Returns string
The formatted string.
- Defined in source/format/bytes.ts:159