Getting started

Installation and usage of the Byte unit converter library.

Install the library using Composer:

composer require open-southeners/byte-unit-converter

Basic usage

To use the library simply import the OpenSoutheners\ByteUnitConverter class and use it:

use OpenSoutheners\ByteUnitConverter\ByteUnitConverter;
use OpenSoutheners\ByteUnitConverter\ByteUnit;

// Use preferably the static method new to construct an instance
(string) ByteUnitConverter::new(1000)->toKB(); // "1.00 KB"
(string) ByteUnitConverter::new(1024)->toKiB(); // "1.00 KiB"

// Or starting from a specific unit (if known)
(string) ByteUnitConverter::new(1000, ByteUnit::MB)->toGB() // "1.00 GB"