Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

filesize.js

hustcc27.4kMIT2.0.0TypeScript support: included

filesize.js is a simple browserjs / nodejs library to make filesize human-readable.

filesize.js, filesize, human-readable, *** kB, iec, is, jedec

readme

filesize.js

filesize.js is a nano(350 b) library to make file size bytes human-readable. e.g. 20.4 Kb.

Build Status npm npm npm

Install

npm install filesize.js

Usage

The unique API is: fileSize(bytes[, fixed=1, spec='jedec']);.

  • bytes: Number of file size bytes.
  • fixed: Number of decimal, default is 1.
  • spec: String of file size spec, default is jedec.
// bytes.
filesize(123456);                 // '120.6 Kb'

// fixed, `1` is default.
filesize(123456, 0);             // '121 Kb'
filesize(123456, 4);             // '1120.5625 Kb'

// specs, `jedec` / `iec / si`.
// `jedec` is default.
filesize(123456, 2, 'iec');     // '120.56 Kib'
filesize(123456, 0, 'si');         // '123 kb'

Test

npm install

npm test

Spec

  • jedec: Unit is ['b', 'Kb', 'Mb', 'Gb', 'Tb', 'Pb', 'Eb', 'Zb', 'Yb'], and the power is 1024.
  • iec: Unit is ['b', 'Kib', 'Mib', 'Gib', 'Tib', 'Pib', 'Eib', 'Zib', 'Yib'], and the power is 1024.
  • si: Unit is ['b', 'kb', 'Mb', 'Gb', 'Tb', 'Pb', 'Eb', 'Zb', 'Yb'], and the power is 1000.

More specs waiting for your issues / pull requests.

LICENSE

MIT@hustcc.