pretty-bytes@5.6.0 官方文檔翻譯

pretty-bytes

將字節轉換爲人類可讀的字符串:' 1337 '→' 1.34 kB '

用於顯示人類可讀的文件大小

注意，它使用base-10(例如，kilobyte)。瞭解kilobyte和kibibyte之間的差別

安裝

$ npm install pretty-bytes

使用

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

prettyBytes(1337);
//=> '1.34 kB'

prettyBytes(100);
//=> '100 B'

// 以bits爲單位的顯示
prettyBytes(1337, {bits: true});
//=> '1.34 kbit'

// 顯示文件大小差別
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

要格式化的數字

options

Type: object

signed

Type: boolean
Default: false

正數包含+號，若是差值剛好爲零，則將使用空格字符代替，以更好地對齊。

bits

Type: boolean
Default: false

將數字格式設置爲bits而不是bytes. 在如下狀況下，這可能會頗有用：例如，關於 bit rate.

binary

Type: boolean
Default: false

使用二進制前綴而不是SI前綴格式化數字。
這對於顯示存儲量可能頗有用。 可是，不該將其用於顯示文件大小。

locale

Type: boolean | string
Default: false (沒有本地化)

重要提示：僅數字和小數點分隔符已本地化。 單元標題不是，也不會本地化。

• 若是 true: 使用系統/瀏覽器區域設置本地化輸出。
• 若是 string: 須要BCP 47語言標籤（例如：en，de等）
• 若是 string[]: 須要BCP 47語言標籤的列表（例如："en"，"de"等）

注意：本地化一般應在瀏覽器中進行。 Node.js須要使用"full-icu"或"system-icu"來構建.或者，能夠使用full-icu模塊在運行時提供支持。 Node.js 13和更高版本默認狀況下都附帶ICU。

minimumFractionDigits

Type: number
Default: undefined

顯示的最小小數位數。

若是未設置"minimumFractionDigits"或"maximumFractionDigits"，則默認行爲是四捨五入到3個有效數字。

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

//顯示至少包含3個小數位的數字
prettyBytes(1900, {minimumFractionDigits: 3});
//=> '1.900 kB'

prettyBytes(1900);
//=> '1.9 kB'

maximumFractionDigits

Type: number
Default: undefined

要顯示的最大小數位數。

若是未設置"minimumFractionDigits"或"maximumFractionDigits"，則默認行爲是四捨五入到3個有效數字。

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

//顯示最多1個小數位數的數字
prettyBytes(1920, {maximumFractionDigits: 1});
//=> '1.9 kB'

prettyBytes(1920);
//=> '1.92 kB'

相關模塊

• pretty-bytes-cli - 次模塊的cli版本
• pretty-ms - 將毫秒轉換爲人類可讀的字符串