sindresorhus

pretty-bytes

Formats the given number using `Number#toLocaleString`.

- If locale is a string, the value is expected to be a locale-key (for example: `de`).

- If locale is true, the system default locale is used for translation.

- If no value for locale is specified, the number is returned unmodified.

const toLocaleString = (number, locale) => {

		result = number.toLocaleString(locale);

		throw new TypeError(`Expected a finite number, got ${typeof number}: ${number}`);

	const prefix = isNegative ? '-' : (options.signed ? '+' : '');

		const numberString = toLocaleString(number, options.locale);

	const exponent = Math.min(Math.floor(Math.log10(number) / 3), UNITS.length - 1);

	// eslint-disable-next-line unicorn/prefer-exponentiation-operator

	number = Number((number / Math.pow(1000, exponent)).toPrecision(3));

	const numberString = toLocaleString(number, options.locale);

	return prefix + numberString + ' ' + unit;

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

	"repository": "sindresorhus/pretty-bytes",

		"test": "xo && NODE_ICU_DATA=node_modules/full-icu ava"

		"test": "xo && NODE_ICU_DATA=node_modules/full-icu ava && tsd"

# pretty-bytes [![Build Status](https://travis-ci.org/sindresorhus/pretty-bytes.svg?branch=master)](https://travis-ci.org/sindresorhus/pretty-bytes)

> 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.](https://web.archive.org/web/20150324153922/https://pacoup.com/2009/05/26/kb-kb-kib-whats-up-with-that/)*

const prettyBytes = require('pretty-bytes');

Include plus sign for positive numbers. If the difference is exactly zero a space character will be prepended instead for better alignment.

- If `true`: Localize the output using the system/browser locale.

- If `string`: Expects a [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)

**Note:** Localization should generally work in browsers. Node.js needs to be [built](https://github.com/nodejs/node/wiki/Intl) with `full-icu` or `system-icu`. Alternatively, the [`full-icu`](https://github.com/unicode-org/full-icu-npm) module can be used to provide support at runtime.

- [pretty-bytes-cli](https://github.com/sindresorhus/pretty-bytes-cli) - CLI for this module

		{
		"name": "pretty-bytes",
		"version": "5.1.0",
		"version": "5.2.0",
		"description": "Convert bytes to a human readable string: 1337 → 1.34 kB",
		@@ -16,6 +16,7 @@ "license": "MIT",
		"scripts": {
		"test": "xo && NODE_ICU_DATA=node_modules/full-icu ava"
		"test": "xo && NODE_ICU_DATA=node_modules/full-icu ava && tsd"
		},
		"files": [
		"index.js"
		"index.js",
		"index.d.ts"
		],
		@@ -39,6 +40,7 @@ "keywords": [
		"devDependencies": {
		"ava": "*",
		"ava": "^1.4.1",
		"full-icu": "^1.2.1",
		"xo": "*"
		"tsd": "^0.7.2",
		"xo": "^0.24.0"
		}
		}

		@@ -41,5 +41,5 @@ # pretty-bytes [![Build Status](https://travis-ci.org/sindresorhus/pretty-bytes.svg?branch=master)](https://travis-ci.org/sindresorhus/pretty-bytes)

		### prettyBytes(input, [options])
		### prettyBytes(number, [options])

		#### input
		#### number

		@@ -52,3 +52,3 @@ Type: `number`

		Type: `Object`
		Type: `object`

		@@ -55,0 +55,0 @@ ##### signed

Improved metrics

Worsened metrics

		@@ -56,2 +56,3 @@ 'use strict';
		const exponent = Math.min(Math.floor(Math.log10(number) / 3), UNITS.length - 1);
		// eslint-disable-next-line unicorn/prefer-exponentiation-operator
		number = Number((number / Math.pow(1000, exponent)).toPrecision(3));
		@@ -58,0 +59,0 @@ const numberString = toLocaleString(number, options.locale);