# bser 中文文档

规范地址：https://npmcn.com/package/bser/

版本：2\.1\.2
npm 元数据更新时间：2026-10-09T17:29:43.035Z
中文译文更新时间：2026-11-05T16:26:34.336Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/bser
原文对照：https://npmcn.com/package/bser/?lang=original
项目主页：https://facebook.github.io/watchman/docs/bser.html
源码仓库：https://github.com/facebook/watchman

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：19.2 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2015-08-24T06:31:54.849Z
- 最新版本发布：2026-10-09T17:29:42.631Z
- 近 30 天下载量：204889559（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 1 个）

## 中文简介

JavaScript 执行 BSER 二进制序列化

## 安装

```sh
npm install bser
```

也可以使用：`pnpm add bser`、`yarn add bser`、`bun add bser`

## README

# BSER 二进制序列化

BSER是二进制序列化方案,可以作为JSON的替代品. BSER 使用框架编码,使流出一个序列更为简单: 编码值.

它只用于本地IPC,字符串作为二进制表示 没有具体的编码; 这符合大多数操作使用的公约 系统文件名存储.

关于系列化方案的更详细情况,请参见: [观察者的文件](https://facebook.github.io/watchman/docs/bser.html)。 。 。 .

## API 密码

```js
var bser = require('bser');
```

### bser. 从缓冲器装入

是同步解码器;给定了输入字符串或缓冲器, 解码单一值并返回。 如果 输入无效.

```js
var obj = bser.loadFromBuffer(buf);
```

### bser.dumpto 缓冲

同步编码一个值为 BSER .

```js
var encoded = bser.dumpToBuffer(['hello']);
console.log(bser.loadFromBuffer(encoded)); // ['hello']
```

### Bunser Buf 软件库

一个同步解码器API在 BunserBuf 对象中被执行. 您可以在此对象上递增附加数据, 它会释放 通过它的解码值 `value` 活动.

```js
var bunser = new bser.BunserBuf();

bunser.on('value', function(obj) {
  console.log(obj);
});
```

然后在你的插座内 `data` 事件:

```js
bunser.append(buf);
```

## 示例

从套接字读取 BSER :

```js
var bunser = new bser.BunserBuf();

bunser.on('value', function(obj) {
  console.log('data from socket', obj);
});

var socket = net.connect('/socket');

socket.on('data', function(buf) {
  bunser.append(buf);
});
```

将 BSER 写入套接字 :

```js
socket.write(bser.dumpToBuffer(obj));
```

## 常见问题

### bser 是什么？

JavaScript 执行 BSER 二进制序列化

### 如何安装 bser？

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

### bser 支持 TypeScript 吗？

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

### bser 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### bser 可以商用吗？

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

### bser 的下载量有多少？

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

### bser 还在维护吗？

最新版本 2\.1\.2 发布于 2026/10/10（27 天前）；至今共发布 8 个版本，其中过去 12 个月发布了 1 个；首次发布于 2015/08/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。