Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inDemoInstall

pretty-bytes

Package Overview
Dependencies
0
Maintainers
1
Versions
25
Issues
File Explorer

Advanced tools

pretty-bytes

Convert bytes to a human readable string: 1337 → 1.34 kB

    6.1.0latest
    Github

Version published
Maintainers
1
Weekly downloads
14,904,394
increased by7.33%

Weekly downloads

Readme

Source

pretty-bytes

Convert bytes to a human readable string: 13371.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.

Install

npm install pretty-bytes

Usage

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'

API

prettyBytes(number, options?)

number

Type: number

The number to format.

options

Type: object

signed

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.

bits

Type: boolean
Default: false

Format the number as bits instead of bytes. This can be useful when, for example, referring to bit rate.

binary

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.

locale

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.

  • If true: Localize the output using the system/browser locale.
  • If string: Expects a BCP 47 language tag (For example: en, de, …)
  • If string[]: Expects a list of BCP 47 language tags (For example: en, de, …)
minimumFractionDigits

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'
maximumFractionDigits

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'
space

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'

Keywords

FAQs

What is pretty-bytes?

Convert bytes to a human readable string: 1337 → 1.34 kB

Is pretty-bytes popular?

The npm package pretty-bytes receives a total of 14,180,063 weekly downloads. As such, pretty-bytes popularity was classified as popular.

Is pretty-bytes well maintained?

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.

Last updated on 04 Feb 2023

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket[email protected]

Product

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc