utils.prettybytes.options

Home > @nipem/utils > PrettyBytes > Options

PrettyBytes.Options interface

Signature:

interface Options 

Properties

Property	Type	Description
binary?	boolean	(Optional) 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.
bits?	boolean	(Optional) Format the number as bits instead of bytes. This can be useful when, for example, referring to bit rate.
locale?	boolean | string | readonly string[]	(Optional) **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, …)**Note**: Localization should generally work in browsers. Node.js needs to be built with full-icu or system-icu. Alternatively, the full-icu module can be used to provide support at runtime. Node.js 13 and later ships with ICU by default.
maximumFractionDigits?	number	(Optional) 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.
minimumFractionDigits?	number	(Optional) The minimum number of fraction digits to displayIf neither minimumFractionDigits or maximumFractionDigits are set, the default behavior is to round to 3 significant digits.
signed?	boolean	(Optional) Include plus sign for positive numbers. If the difference is exactly zero a space character will be prepended instead for better alignment.