sindresorhus

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 `false`: Output won't be localized.

		- 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.

		Format the number as [bits](https://en.wikipedia.org/wiki/Bit) instead of [bytes](https://en.wikipedia.org/wiki/Byte). This can be useful when, for example, referring to [bit rate](https://en.wikipedia.org/wiki/Bit_rate).

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

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

import prettyBytes = require('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}`);

	options = Object.assign({bits: false}, options);

	const UNITS = options.bits ? BIT_UNITS : BYTE_UNITS;

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

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

		return prefix + numberString + ' ' + UNITS[0];

	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 && 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.

Format the number as [bits](https://en.wikipedia.org/wiki/Bit) instead of [bytes](https://en.wikipedia.org/wiki/Byte). This can be useful when, for example, referring to [bit rate](https://en.wikipedia.org/wiki/Bit_rate).

- 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

		@@ -20,2 +20,16 @@ declare namespace prettyBytes {
		readonly locale?: boolean \| string;

		/**
		Format the number as [bits](https://en.wikipedia.org/wiki/Bit) instead of [bytes](https://en.wikipedia.org/wiki/Byte). This can be useful when, for example, referring to [bit rate](https://en.wikipedia.org/wiki/Bit_rate).

		@default false

		```
		import prettyBytes = require('pretty-bytes');

		prettyBytes(1337, {bits: true});
		//=> '1.34 kbit'
		```
		*/
		readonly bits?: boolean;
		}
		@@ -22,0 +36,0 @@ }

		'use strict';

		const UNITS = [
		const BYTE_UNITS = [
		'B',
		@@ -15,2 +15,14 @@ 'kB',

		const BIT_UNITS = [
		'b',
		'kbit',
		'Mbit',
		'Gbit',
		'Tbit',
		'Pbit',
		'Ebit',
		'Zbit',
		'Ybit'
		];

		/*
		@@ -38,6 +50,7 @@ Formats the given number using `Number#toLocaleString`.

		options = Object.assign({}, options);
		options = Object.assign({bits: false}, options);
		const UNITS = options.bits ? BIT_UNITS : BYTE_UNITS;

		if (options.signed && number === 0) {
		return ' 0 B';
		return ' 0 ' + UNITS[0];
		}
		@@ -54,3 +67,3 @@
		const numberString = toLocaleString(number, options.locale);
		return prefix + numberString + ' B';
		return prefix + numberString + ' ' + UNITS[0];
		}
		@@ -57,0 +70,0 @@

		{
		"name": "pretty-bytes",
		"version": "5.2.0",
		"version": "5.3.0",
		"description": "Convert bytes to a human readable string: 1337 → 1.34 kB",
		@@ -5,0 +5,0 @@ "license": "MIT",

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

		// Display with units of bits
		prettyBytes(1337, {bits: true});
		//=> '1.34 kbit'

		// Display file size differences
		@@ -61,3 +65,9 @@ prettyBytes(42, {signed: true});

		##### bits

		Type: `boolean`<br>
		Default: `false`

		Format the number as [bits](https://en.wikipedia.org/wiki/Bit) instead of [bytes](https://en.wikipedia.org/wiki/Byte). This can be useful when, for example, referring to [bit rate](https://en.wikipedia.org/wiki/Bit_rate).

		##### locale
		@@ -64,0 +74,0 @@

Improved metrics