convert-size v1.2.1

convert-size

convert-size is a package to convert a size with bytes to units such as KB MB TB

BIG NOTE

this package is now a mirror of to a bigger package called convert-pro only convert.bytes this means that this package will have exactly the same api as convert.bytes in convert-pro

but DON'T WORRY IT WILL BE BACKWARDS COMPATIBLE

IT SHOULD WORK JUST FINE

if you have any issue or PR do it in convert-pro's github repo NOT in "convert-size"'s

Usage

// on node (commonjs)
const { default: convertSize } = require("convert-size");
// or (es6)
import convertSize from "convert-size";
// on deno (replace version with current version)
import convertSize from "https://x.nest.land/convert-size@version/mod.ts";
// or
import convertSize from "https://deno.land/x/convert_size@version/mod.ts";

convertSize(1000); // => 1 KB
convertSize(1000 * 1000); // => 1 MB
convertSize("1 MB"); // => 1000000
convertSize("1 GB", "MB"); // => 1000
convertSize(1000000, "KB"); // => 1000
convertSize("1 mb", "GB", { stringify: true }); // => 0.001 GB
// convert multiple units
convertSize("10 kb 1 mb"); // => 1001000
convertSize("10 kib 1 mb"); // => 1001024
convertSize("10 kib 1 mb", "kb"); // => 1001.024

// to know more about option read the options part below
convertSize(1000 * 1000, {
  accuracy: 0,
  shortcut: false,
}); // => 1 Kilo Byte

options

accuracy

this options is the accuracy of the size or how many digits are there after the dot

example:

import { convertSize } from "convert-size";

convertSize(1024, { accuracy: 0 }); // => 1 KB

shortcut

this option tels the function to use the shortcuts or the words

example:

import { convertSize } from "convert-size";

convertSize(1024, { shortcut: false }); // => 1.00 Kilo Byte

lowerCase

this option tels the function to use lower case letters

import { convertSize } from "convert-size";

convertSize(1024, { lowerCase: true }); // => 1 kb

License

Copyright (c) 2019 AliBasicCoder