bytez
> A module to take a number or string value representing byte-size, and outputting a human-readable string.
This module can output as either Bytes(8 bits) or Bits, as well as kibibytes(base 2 - 1024) or normal(base 10 - 1000) values, or any combination of either.
By default, the converter will output normal Bytes as most people are used to (hard drive manufacturers advertsie their storage amounts in this manner.)
Install
``
sh
yarn add bytez
`
Usage
`
js
const bytez = require('bytez')
// use Numbers or Strings
console.log(bytez(4200)) // "4.2KB" (4.2 kilobytes)
console.log(bytez("42000")) // "42KB" (42 kiloBytes)
// set precision
console.log(bytez(426988240, {
precision: 3 // sets precision to 3 decimal places (default is 1)
})) // "426.988MB" (426.988 MegaBytes)
// all using the same 500GB input
console.log(bytez(500000000000,{
base2: false
})) // "500GB" (500 GigaBytes)
console.log(bytez(500000000000,{
base2: true
})) // "465.7GiB" (465.7 GibiBytes)
console.log(bytez(500000000000,{
base2: true,
bits: true
})) // "3.6Tibit" (3.6 Tebibits)
``
Options
$3
Boolean, default: false
Option to set whether your string will be output as normal base10 sizes (1MB is 1000kB) or base2 (1MiB is 1024kiB).
$3
Boolean, default: false
Option to determine if output string uses Bytes or bits). 1 Byte == 8 bits.
$3
Number(int), default: 1
Number of significant figure digits to output.
Output Formats
| Options | Appendation | Example |
| --------- | ----------- | --------- |
| Bytes | "B" | "420MB" |
| Bits | "bits" | "420Mbit" |
| (Base 10) | k, M, G | "420MB" |
| (Base 2) | ki, Mi, Gi | "420MiB" |
Author
š¤
Jake Miller
* Website:
jakemiller.dev
* Github:
@neuralworm