pretty-bytes
Advanced tools
Package description
The pretty-bytes npm package is a utility that converts bytes to a human-readable string. It takes a numeric value representing the number of bytes and returns a string with a more readable format, including the appropriate unit such as bytes, kilobytes, megabytes, etc.
Convert bytes to a human-readable string
This feature allows you to convert a numeric value of bytes into a string that represents the size in a more understandable format, automatically choosing the right unit.
const prettyBytes = require('pretty-bytes');
console.log(prettyBytes(1024)); // '1 kB'Convert bytes to a human-readable string with options
This feature allows you to specify options such as using binary (IEC) units instead of metric (SI) units, which changes the way the units are calculated and displayed.
const prettyBytes = require('pretty-bytes');
console.log(prettyBytes(1000, {binary: true})); // '1000 B'
console.log(prettyBytes(1024, {binary: true})); // '1 KiB'Locale support
This feature allows you to format the number using a locale string, which affects the output by using the appropriate decimal separator and grouping for the specified locale.
const prettyBytes = require('pretty-bytes');
console.log(prettyBytes(123456789, {locale: 'de'})); // '123,5 MB'The filesize package provides similar functionality to pretty-bytes, allowing for human-readable file size strings from byte amounts. It offers additional options for customization, such as setting the number of decimal places, and has methods for partial application.
The bytes package is another alternative that formats byte sizes into human-readable strings. It supports conversion from a string with a unit back to bytes, which pretty-bytes does not do.
Readme
Convert bytes to a human readable string:
1337→1.34 kB
Useful for displaying file sizes for humans.
Note that it uses base-10 (e.g. kilobyte). Read about the difference between kilobyte and kibibyte.
$ npm install pretty-bytes
const prettyBytes = require('pretty-bytes');
prettyBytes(1337);
//=> '1.34 kB'
prettyBytes(100);
//=> '100 B'
// Display file size differences
prettyBytes(42, {signed: true});
//=> '+42 B'
// Localized output using German locale
prettyBytes(1337, {locale: 'de'});
//=> '1,34 kB'
Type: number
The number to format.
Type: Object
Type: boolean
Default: false
Include plus sign for positive numbers. If the difference is exactly zero a space character will be prepended instead for better alignment.
Type: boolean string
Default: false (No localization)
true: Localize the output using the system/browser locale.string: Expects a BCP 47 language tag (For example: en, de, …)Note: Localization should generally work in browsers. Node.js needs to be built with full-icu or system-icu. Alternatively, the full-icu module can be used to provide support at runtime.
MIT © Sindre Sorhus
FAQs
Convert bytes to a human readable string: 1337 → 1.34 kB
The npm package pretty-bytes receives a total of 12,893,319 weekly downloads. As such, pretty-bytes popularity was classified as popular.
We found that pretty-bytes demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.