bytes

中文文档
3.1.2发布于 2022/01/28MIT零依赖近 30 天下载 5.7亿

实用程序将字符串解析为字节,反之亦然

中文使用文档
文档目录3 节
  1. 安装
  2. 用法
  3. 许可证

字节效用

NPM Version NPM Downloads Build Status Test Coverage

用于解析字符串字节的实用程序(例如: 1TB)到字节(1099511627776),反之亦然。

安装

这是一个 node . js 模块可通过 npm注册表. 安装是使用 npm install 命令:

$ npm install bytes

用法

var bytes = require('bytes');

Bytes (number|string value, [options]): number|string|null

默认导出功能。委托给任一方 bytes.format 或 bytes.parse 基于类型 value。

参数

名字类型描述
价值number|string要格式化的数值或要解析的字符串值
选项Object转换选项 format

返回

名字类型描述
结果string|number|null错误时返回null。以字节为单位的数字值,否则为字符串值。

例子

bytes(1024);
// output: '1KB'

bytes('1KB');
// output: 1024

字节。格式(数值,[options]): string|null

将给定的值以字节为单位格式化为字符串。如果值为负,则保持为负。如果它是浮点数,它就是 圆。

参数

名字类型描述
价值number以字节为单位的值
选项Object转换选项

选项

财产类型描述
decimalPlacesnumber|null输出中要包含的最大小数位数。默认值为 2。
fixedDecimalsboolean|null是否始终显示小数点后位数的最大值。默认值为 false
thousandsSeparatorstring|null值的例子: ' ', ',' 和 '.'…默认值为 ''。
单位string|null返回结果的单位(B/KB/MB/GB/TB)。默认值为 '' (意思是自动检测)。
unitSeparatorstring|null数字和单位之间使用的分隔符。默认值为 ''。

返回

名字类型描述
结果string|null错误时返回null。否则为字符串值。

例子

bytes.format(1024);
// output: '1KB'

bytes.format(1000);
// output: '1000B'

bytes.format(1000, {thousandsSeparator: ' '});
// output: '1 000B'

bytes.format(1024 * 1.7, {decimalPlaces: 0});
// output: '2KB'

bytes.format(1024, {unitSeparator: ' '});
// output: '1 KB'

字节。解析(string|number value): number|null

将字符串值解析为以字节为单位的整数。如果未给出单位,则为 value 是一个数字,则假定该值以字节为单位。

支持的单位和缩写如下,不区分大小写:

  • b 为字节
  • kb 为千字节
  • mb 为字节
  • gb 为字节
  • tb 为字节
  • pb 对pb

单位是2的幂,不是10。根据这个解析器,这意味着1kb = 1024b。

参数

名字类型描述
价值string|number要解析的字符串,或以字节为单位的数字。

返回

名字类型描述
结果number|null错误时返回null。否则以字节为单位。

例子

bytes.parse('1KB');
// output: 1024

bytes.parse('1024');
// output: 1024

bytes.parse(1024);
// output: 1024

许可证

麻省理工学院

版本与发布记录

bytes 共发布 18 个版本,首次发布于 2012/06/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.1.2latest2022/01/284 年前
3.1.12021/11/164 年前
3.1.02019/01/237 年前
3.0.02017/09/019 年前
2.5.02017/03/259 年前
2.4.02016/06/0210 年前

关于 bytes 的常见问题

bytes 是什么?

实用程序将字符串解析为字节,反之亦然

如何安装 bytes?

在项目目录运行 npm install bytes,或使用 pnpm add / yarn add / bun add。

bytes 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/bytes 是否存在。

bytes 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >= 0.8。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

bytes 可以商用吗?

bytes 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

bytes 的下载量有多少?

根据 npm 官方下载统计,bytes 在 2026/10/05 – 2026/11/03 这 30 天内被下载 571,911,362 次,日均约 19,063,712 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

bytes 还在维护吗?

最新版本 3.1.2 发布于 2022/01/28(4 年前);至今共发布 18 个版本,其中过去 12 个月发布了 0 个;首次发布于 2012/06/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。