Package Exports

filesize

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (filesize) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

filesize.js

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

Optional settings

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

base

(number) Number base, default is 2

bits

(boolean) Enables bit sizes, default is false

exponent

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

output

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

round

(number) Decimal place, default is 2

spacer

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

suffixes

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

unix

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

Examples

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

How can I load filesize.js?

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

filesize