pretty-bytes
- Version 6.1.1
- Published
- 11.3 kB
- No dependencies
- MIT license
Install
npm i pretty-bytes
yarn add pretty-bytes
pnpm add pretty-bytes
Overview
Convert bytes to a human readable string: 1337 → 1.34 kB
Index
Functions
Type Aliases
Functions
function prettyBytes
prettyBytes: (number: number, options?: Options) => string;
Convert bytes to a human readable string:
1337
→1.34 kB
.Parameter number
The number to format.
Example 1
import prettyBytes from 'pretty-bytes';prettyBytes(1337);//=> '1.34 kB'prettyBytes(100);//=> '100 B'// Display file size differencesprettyBytes(42, {signed: true});//=> '+42 B'// Localized output using German localeprettyBytes(1337, {locale: 'de'});//=> '1,34 kB'
Type Aliases
type Options
type Options = { /** Include plus sign for positive numbers. If the difference is exactly zero a space character will be prepended instead for better alignment.
@default false */ readonly signed?: boolean;
/** - 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`, …) - If `string[]`: Expects a list of [BCP 47 language tags](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)
@default false */ readonly locale?: boolean | string | readonly 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
@example ``` import prettyBytes from 'pretty-bytes';
prettyBytes(1337, {bits: true}); //=> '1.34 kbit' ``` */ readonly bits?: boolean;
/** Format the number using the [Binary Prefix](https://en.wikipedia.org/wiki/Binary_prefix) instead of the [SI Prefix](https://en.wikipedia.org/wiki/SI_prefix). This can be useful for presenting memory amounts. However, this should not be used for presenting file sizes.
@default false
@example ``` import prettyBytes from 'pretty-bytes';
prettyBytes(1000, {binary: true}); //=> '1000 bit'
prettyBytes(1024, {binary: true}); //=> '1 kiB' ``` */ readonly binary?: boolean;
/** 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.
@default undefined
@example ``` 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' ``` */ readonly minimumFractionDigits?: number;
/** 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.
@default undefined
@example ``` 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' ``` */ readonly maximumFractionDigits?: number;
/** Put a space between the number and unit.
@default true
@example ``` import prettyBytes from 'pretty-bytes';
prettyBytes(1920, {space: false}); //=> '1.9kB'
prettyBytes(1920); //=> '1.92 kB' ``` */ readonly space?: boolean;};
Package Files (1)
Dependencies (0)
No dependencies.
Dev Dependencies (3)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/pretty-bytes
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/pretty-bytes)
- HTML<a href="https://www.jsdocs.io/package/pretty-bytes"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1075 ms. - Missing or incorrect documentation? Open an issue for this package.