An Elixir library to make file sizes human-readable.
The package can be installed as:
- Add
sizeable
to your list of dependencies inmix.exs
:
```elixir
def deps do
[{:sizeable, "~> 0.1.5"}]
end
```
- Ensure
sizeable
is started before your application:
```elixir
def application do
[applications: [:sizeable]]
end
```
Returns a human-readable string for the given numeric value.
value
(Integer/Float/String) representing the filesize to be converted.options
(Struct) representing the options to determine base, rounding and units.
bits
:true
if the result should be in bits,false
if in bytes. Defaults tofalse
.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 to2
.base
: the base for exponent calculation.2
for binary-based numbers, any other Integer can be used. Defaults to2
.
Sizeable.filesize(1024)
"1 KB"
Sizeable.filesize(1024, %{bits:true})
"8 Kb"