filesize

What is filesize?

The filesize npm package is a library designed to provide simple file size conversion and formatting. It allows users to convert raw file size numbers into human-readable strings, with support for multiple units and customization options. This can be particularly useful in applications where file sizes need to be displayed to users in a format that is easy to understand.

What are filesize's main functionalities?

Basic file size formatting

Converts a file size in bytes to a human-readable string using the most appropriate unit. In this example, 1024 bytes are converted to '1 KB'.

"const filesize = require('filesize');
console.log(filesize(1024)); // '1 KB'"

Customizing the output

Allows customization of the output format, including rounding and the spacer between the number and the unit. This example shows no rounding and removes the space between the number and the unit.

"const filesize = require('filesize');
console.log(filesize(1024, {round: 0, spacer: ''})); // '1KB'"

Using different units

Supports using different unit standards, such as the International Electrotechnical Commission (IEC) standard, which uses 'KiB' instead of 'KB' for 1024 bytes.

"const filesize = require('filesize');
console.log(filesize(1024, {standard: 'iec'})); // '1 KiB'"

Other packages similar to filesize

pretty-bytes

Similar to filesize, pretty-bytes converts byte values into a human-readable format. It focuses on simplicity and does not offer as many customization options as filesize, making it a good choice for straightforward use cases.

bytes

The bytes package also provides functionality for formatting byte sizes into human-readable strings. It offers a balance between simplicity and customization, with options to specify the number of decimal places and the units to use.

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. An optional second parameter is the decimal place to round to (default is 2), or true which triggers Unix style output.

Examples

filesize(500);                    // "3.91Kb"
filesize(500, true);              // "3.9k"
filesize(1500);                   // "1.46KB"
filesize("1500000000");           // "1.40GB"
filesize("1500000000", 0);        // "1GB"
filesize(1212312421412412);       // "1.08PB"
filesize(1212312421412412, true); // "1.1P" - shorthand output, similar to *nix "ls -lh"

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.

Information

License

filesize.js is licensed under BSD-3 http://www.opensource.org/licenses/BSD-3-Clause

Copyright

Copyright (c) 2012, Jason Mulligan [e-mail]

Changelog

1.7.8

5 February 2013

• Minor refactoring #19
• Adding support for zero as a parameter 5075979