PrettySize

Helper utility to provide pretty printed file sizes (best used for logging or CLI output)

Build Status

Usage

npm install prettysize

1
2const pretty = require('prettysize');
3
4let str = pretty(1024);
5  //str = "1 kB"
6
7    str = pretty(1024 * 1024);
8  //str = "1 MB"
9
10    str = pretty(123456789);
11  //str = "117.7 MB"

It supports the following sizes:

• bytes
• kB
• MB
• GB
• TB
• PB
• EB

Arguments

1pretty(123456, true, true, 2);
2
3/*
4
5First arg is size
6Second argument is to remove the space from the output
7Third argument is to use a single character for the size.
8Forth argument is the number of decimal places to return, default is 1.
9Fith argument is to return a converted number without the size string.
10*/
11
12
13let str = pretty(1024 * 1024, true);
14  //str = "1MB"
15
16    str = pretty(123456789, {nospace: true}) // pretty(123456789, true, true);
17  //str = "117.7M"
18
19    str = pretty(123456789, {one: true}) // pretty(123456789, false, true);
20  //str = "117.7 M"
21
22    str = pretty(123456789, {one: true, places: 2}) // pretty(123456789, false, true, 2);
23  //str = "117.74 M"
24
25   str = pretty(123456789, {one: true, places: 3}) // pretty(123456789, false, true, 3);
26 //str = "117.738 M"
27
28   str = pretty(123456789, {numOnly: true}) // pretty(123456789, false, false, false, true);
29 //num = 117.7
30