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
import prettyBytes from 'pretty-bytes';
prettyBytes(1337);
//=> '1.34 kB'
prettyBytes(100);
//=> '100 B'
// Display with units of bits
prettyBytes(1337, {bits: true});
//=> '1.34 kbit'
// 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
Default: false
Format the number as bits instead of bytes. This can be useful when, for example, referring to bit rate.
Type: boolean
Default: false
Format the number using the Binary Prefix instead of the SI Prefix. This can be useful for presenting memory amounts. However, this should not be used for presenting file sizes.
Type: boolean | string
Default: false (No localization)
Important: Only the number and decimal separator are localized. The unit title is not and will not be localized.
true: Localize the output using the system/browser locale.string: Expects a BCP 47 language tag (For example: en, de, …)string[]: Expects a list of BCP 47 language tags (For example: en, de, …)Type: number
Default: undefined
The minimum number of fraction digits to display.
If neither minimumFractionDigits or maximumFractionDigits are set, the default behavior is to round to 3 significant digits.
import prettyBytes from 'pretty-bytes';
// Show the number with at least 3 fractional digits
prettyBytes(1900, {minimumFractionDigits: 3});
//=> '1.900 kB'
prettyBytes(1900);
//=> '1.9 kB'
Type: number
Default: undefined
The maximum number of fraction digits to display.
If neither minimumFractionDigits or maximumFractionDigits are set, the default behavior is to round to 3 significant digits.
import prettyBytes from 'pretty-bytes';
// Show the number with at most 1 fractional digit
prettyBytes(1920, {maximumFractionDigits: 1});
//=> '1.9 kB'
prettyBytes(1920);
//=> '1.92 kB'
Type: boolean
Default: true
Put a space between the number and unit.
import prettyBytes from 'pretty-bytes';
prettyBytes(1920, {space: false});
//=> '1.9kB'
prettyBytes(1920);
//=> '1.92 kB'
FAQs
Convert bytes to a human readable string: 1337 → 1.34 kB
The npm package pretty-bytes receives a total of 13,143,156 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
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.