JavaScript library to generate a human readable String describing the file size


filesize.js provides a simple way to get a human readable file size string from a number (float or integer) or string.

filesize() accepts an optional descriptor Object as a second argument, so you can customize the output.

(number) Number base, default is 2

(boolean) Enables bit sizes, default is false

(number) Specifies the SI suffix via exponent, e.g. 2 is MB for bytes, default is -1

(string) Output of function (array, exponent, object, or string), default is string

(number) Decimal place, default is 2

(string) Character between the result and suffix, default is " "

(object) Dictionary of SI suffixes to replace for localization, defaults to english if no match is found

(boolean) Enables unix style human readable output, e.g ls -lh, default is false

filesize(500);                        // "500 B" 
filesize(500, {bits: true});          // "4 kb" 
filesize(265318, {base: 10});         // "265.32 kB" 
filesize(265318);                     // "259.1 kB" 
filesize(265318, {round: 0});         // "259 kB" 
filesize(265318, {output: "array"});  // [259.1, "kB"] 
filesize(265318, {output: "object"}); // {value: 259.1, suffix: "kB"} 
filesize(1, {suffixes: {B: "Б"}});    // "1 Б" 
filesize(1024);                       // "1 kB" 
filesize(1024, {exponent: 0});        // "1024 B" 
filesize(1024, {output: "exponent"}); // 1 

filesize.js supports AMD loaders (require.js, curl.js, etc.), node.js & npm (npm install filesize), or using a script tag.

Copyright (c) 2015 Jason Mulligan Licensed under the BSD-3 license.