sizeable v1.0.2 Sizeable

A library to make file sizes human-readable

Summary

Functions

see filesize(value, options)

Returns a human-readable string for the given numeric value

Functions

filesize(value)

see filesize(value, options)

filesize(value, options)

Returns a human-readable string for the given numeric value.

Arguments:

  • value (Integer/Float/String) representing the filesize to be converted.
  • options (Struct) representing the options to determine base, rounding and units.

Options

  • bits: true if the result should be in bits, false if in bytes. Defaults to false.
  • spacer: the string that should be between the number and the unit. Defaults to " ".
  • round: the precision that the number should be rounded down to. Defaults to 2.
  • base: the base for exponent calculation. 2 for binary-based numbers, any other Integer can be used. Defaults to 2.
  • output: the ouput format to be used, possible options are :string, :list, :map. Defaults to :string.

Example - Get bit-sized file size for 1024 byte

Sizeable.filesize(1024, bits: true) “8 Kb”

filesize_output(output, result, unit, spacer)