@types/bytes

Functions

• bytes()
• format()
• parse()

Interfaces

• BytesOptions

  • decimalPlaces
  • fixedDecimals
  • thousandsSeparator
  • unit
  • unitSeparator

Type Aliases

• Unit

function bytes

bytes: typeof bytes;

• Convert the given value in bytes into a string.

  Parameter value

  Number of bytes to convert.

  Parameter options

  Formatting options.

  Returns

  Formatted string, or null if value is invalid.

  Example 1

  bytes(1024); // '1KB' bytes(1000, { thousandsSeparator: ' ' }); // '1 000B'

• Parse string to an integer in bytes.

  Parameter value

  String representation of bytes to parse.

  Returns

  Number of bytes, or null if value is invalid.

  Example 1

  bytes('1KB'); // 1024 bytes('10.5MB'); // 11010048

function format

format: (value: number, options?: BytesOptions) => string | null;

• Format the given value in bytes into a string.

  If the value is negative, it is kept as such. If it is a float, it is rounded.

  Parameter value

  Number of bytes to format.

  Parameter options

  Formatting options.

  Returns

  Formatted string, or null if value is invalid.

function parse

parse: (value: string | number) => number | null;

• Parse the string value into an integer in bytes.

  If no unit is given, it is assumed the value is in bytes.

  Parameter value

  String representation or number to parse.

  Returns

  Number of bytes, or null if value is invalid.

type Unit

type Unit =
    | 'b'
    | 'gb'
    | 'kb'
    | 'mb'
    | 'pb'
    | 'tb'
    | 'B'
    | 'GB'
    | 'KB'
    | 'MB'
    | 'PB'
    | 'TB';