filesize
JavaScript library to generate a human readable String describing the file size
Last updated 3 months ago by avoidwork .
BSD-3-Clause · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install filesize 
SYNC missed versions from official npm registry.

filesize.js

build status downloads CDNJS version

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 symbol via exponent, e.g. 2 is MB for base 2, default is -1

fullform

(boolean) Enables full form of unit of measure, default is false

fullforms

(array) Array of full form overrides, default is []

locale (overrides 'separator')

(string || boolean) BCP 47 language tag to specify a locale, or true to use default locale, default is ""

localeOptions (overrides 'separator', requires string for 'locale' option)

(object) Dictionary of options defined by ECMA-402 (Number.prototype.toLocaleString). Requires locale option to be explicitly passed as a string, otherwise is ignored.

output

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

round

(number) Decimal place, default is 2

separator

(string) Decimal separator character, default is .

spacer

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

standard

(string) Standard unit of measure, can be iec or jedec, default is jedec; can be overruled by base

symbols

(object) Dictionary of SI/JEDEC/IEC symbols 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, symbol: "KB", exponent: 1}
filesize(1, {symbols: {B: "Б"}});     // "1 Б"
filesize(1024);                       // "1 KB"
filesize(1024, {exponent: 0});        // "1024 B"
filesize(1024, {output: "exponent"}); // 1
filesize(265318, {standard: "iec"});  // "259.1 KiB"
filesize(265318, {standard: "iec", fullform: true}); // "259.1 kibibytes"
filesize(12, {fullform: true, fullforms: ["байтов"]});  // "12 байтов"
filesize(265318, {separator: ","});   // "259,1 KB"
filesize(265318, {locale: "de"});   // "259,1 KB"

Partial Application

filesize.partial() takes the second parameter of filesize() and returns a new function with the configuration applied upon execution. This can be used to reduce Object creation if you call filesize() without caching the descriptor in lexical scope.

const size = filesize.partial({standard: "iec"});

size(265318); // "259.1 KiB"

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.

An ES6 version is bundled with an npm install, but requires you load it with the full path, e.g. require(path.join(__dirname, 'node_modules', 'filesize', 'lib', 'filesize.es6.js')).

License

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

Current Tags

  • 6.1.0                                ...           latest (3 months ago)

76 Versions

  • 6.1.0                                ...           3 months ago
  • 6.0.1                                ...           7 months ago
  • 6.0.0                                ...           7 months ago
  • 5.0.3                                ...           8 months ago
  • 5.0.2                                ...           8 months ago
  • 5.0.1                                ...           8 months ago
  • 5.0.0                                ...           8 months ago
  • 4.2.1                                ...           8 months ago
  • 4.2.0                                ...           9 months ago
  • 4.1.2                                ...           a year ago
  • 4.1.1                                ...           a year ago
  • 4.0.0                                ...           a year ago
  • 3.6.1                                ...           2 years ago
  • 3.6.0                                ...           2 years ago
  • 3.5.11                                ...           3 years ago
  • 3.5.10                                ...           3 years ago
  • 3.5.9                                ...           3 years ago
  • 3.5.8                                ...           3 years ago
  • 3.5.7                                ...           3 years ago
  • 3.5.6                                ...           3 years ago
  • 3.5.5                                ...           3 years ago
  • 3.5.4                                ...           3 years ago
  • 3.5.3                                ...           3 years ago
  • 3.5.2                                ...           3 years ago
  • 3.5.1                                ...           3 years ago
  • 3.5.0                                ...           3 years ago
  • 3.4.3                                ...           3 years ago
  • 3.4.2                                ...           3 years ago
  • 3.4.1                                ...           3 years ago
  • 3.4.0                                ...           3 years ago
  • 3.3.0                                ...           4 years ago
  • 3.2.1                                ...           4 years ago
  • 3.2.0                                ...           4 years ago
  • 3.1.6                                ...           4 years ago
  • 3.1.5                                ...           4 years ago
  • 3.1.4                                ...           5 years ago
  • 3.1.3                                ...           5 years ago
  • 3.1.2                                ...           5 years ago
  • 3.1.1                                ...           5 years ago
  • 3.1.0                                ...           5 years ago
  • 3.0.2                                ...           5 years ago
  • 3.0.1                                ...           5 years ago
  • 3.0.0                                ...           5 years ago
  • 2.0.4                                ...           6 years ago
  • 2.0.3                                ...           6 years ago
  • 2.0.2                                ...           6 years ago
  • 2.0.1                                ...           6 years ago
  • 2.0.0                                ...           7 years ago
  • 1.10.0                                ...           7 years ago
  • 1.9.7                                ...           7 years ago
  • 1.9.6                                ...           7 years ago
  • 1.9.5                                ...           7 years ago
  • 1.9.4                                ...           7 years ago
  • 1.9.3                                ...           7 years ago
  • 1.9.2                                ...           7 years ago
  • 1.9.1                                ...           7 years ago
  • 1.9.0                                ...           7 years ago
  • 1.8.0                                ...           7 years ago
  • 1.7.9                                ...           7 years ago
  • 1.7.8                                ...           7 years ago
  • 1.7.7                                ...           7 years ago
  • 1.7.6                                ...           7 years ago
  • 1.7.5                                ...           7 years ago
  • 1.7.4                                ...           7 years ago
  • 1.7.3                                ...           7 years ago
  • 1.7.2                                ...           8 years ago
  • 1.7.1                                ...           8 years ago
  • 1.7.0                                ...           8 years ago
  • 1.6.7                                ...           8 years ago
  • 1.6.6                                ...           8 years ago
  • 1.6.5                                ...           8 years ago
  • 1.6.4                                ...           8 years ago
  • 1.6.3                                ...           8 years ago
  • 1.6.2                                ...           8 years ago
  • 1.6.1                                ...           8 years ago
  • 1.6.0                                ...           8 years ago
Maintainers (1)
Downloads
Today 13,126
This Week 95,392
This Month 542,428
Last Day 27,527
Last Week 147,709
Last Month 620,878
Dependencies (0)
None
Dev Dependencies (12)
Dependents (1394)

Copyright 2014 - 2016 © taobao.org |